add manpage

diff --git a/Makefile.am b/Makefile.am
index a97da71e099e0283b6cf693391bfd04ac8d5dae0..1886fa1f60d8fa47f0bb88a243adcd450881193c 100644 (file)
--- a/Makefile.am
+++ b/Makefile.am
@@ -7,5 +7,6 @@ jackwsmeter_LDADD = $(JACK_LIBS) $(WEBSOCKETS_LIBS) $(LIBM)
 htmldir = $(datadir)/jackswmeter
 html_DATA = jackwsmeter.html
 
+man_MANS = jackwsmeter.1
 
-EXTRA_DIST = $(html_DATA) AUTHORS README
+EXTRA_DIST = $(html_DATA) $(man_MANS) AUTHORS README

diff --git a/TODO b/TODO
index 25248d682d32c93a7a983396f11d474e8ca21095..135e48251bab4013fbcb96f445fcba54edb35b3f 100644 (file)
--- a/TODO
+++ b/TODO
@@ -1,4 +1,3 @@
 - documentation
   - README (including protocol description)
-  - manpage
 - arg to set refresh rate (?)

diff --git a/jackwsmeter.1 b/jackwsmeter.1
new file mode 100644 (file)
index 0000000..e16e2d2
--- /dev/null
+++ b/jackwsmeter.1
@@ -0,0 +1,54 @@
+.TH jackwsmeter "1" 0.5 "July 2014"
+.SH NAME
+jackwsmeter \- jack meter over websockets
+.SH SYNOPSYS
+.B jackswmeter
+.RI [ options ]
+.RI portname
+.RI [ portname ]
+.RI [ portname ]
+.RI ...
+.br
+.SH DESCRIPTION
+\fBjackwsmeter\fR get the signal values of the audio signals that flow
+through JACK ports and make the peak levels available over a websocket
+link.
+
+.SH OPTIONS
+jackwsmeter supports up to 20 input ports, they may be created connected
+to existing output ports, or unconnected if invalid port names are given.
+
+A summary of options is included below.
+
+.TP
+.B \-p, \-\-port=PORT
+.br
+Use PORT as the HTTP/Websocket port, instead of the default 7681
+.TP
+.B \-i, \-\-interface=INTERFACE
+Bind to the specified interface
+.TP
+.B \-\-ssl-cert=FILEPATH, --ssl-private-key=FILEPATH
+Use the specified certificate and private key to secure the connection
+.TP
+.B \-d, \-\-daemonize
+Daemonize the process
+.TP
+.B \-n, \-\-name=NAME
+Register as a jack client with the specified NAME, instead of the default jackswmeter
+
+.SH EXAMPLE
+.PP
+Start in foreground connected to two exiting output ports, open your browser
+at http://localhost:7681 afterwards.
+.IP
+\fBjackwsmeter\fR system:capture_1 system:capture_2
+
+.SH SEE ALSO
+.BR jackd (1),
+.BR jackmeter (1),
+.BR meterbridge (1)
+.br
+
+.SH AUTHOR
+Frederic Peters <fpeters@0d.be>