[Debian-iot-packaging] [openzwave-controlpanel] 05/05: Extent man page and package description

[Dara Adib]

This is an automated email from the git hooks/post-receive script.

daradib-guest pushed a commit to branch debian/master
in repository openzwave-controlpanel.

commit 26b1d329c2ba0e809353f837ad10733465daa390
Author: Dara Adib <daradib at ocf.berkeley.edu>
Date:   Sat Dec 24 15:55:37 2016 -0500

    Extent man page and package description
---
 debian/control |  4 +++-
 debian/ozwcp.1 | 38 +++++++++++++++++++++++++++++++++++---
 2 files changed, 38 insertions(+), 4 deletions(-)

diff --git a/debian/control b/debian/control
index 3d23683..6663b05 100644
--- a/debian/control
+++ b/debian/control
@@ -13,5 +13,7 @@ Package: openzwave-controlpanel
 Architecture: any
 Depends: libjs-bootstrap, libjs-jquery, ${shlibs:Depends}, ${misc:Depends}
 Description: OpenZWave Control Panel
- OpenZWave Control Panel (ozwcp) permits users to query, manage and
+ OpenZWave Control Panel (ozwcp) permits users to query, manage, and
  monitor Z-Wave nodes and networks. It provides a web-based user interface.
+ Some example uses include adding/removing nodes, testing commands,
+ and viewing/changing node configuration parameters.
diff --git a/debian/ozwcp.1 b/debian/ozwcp.1
index ad4302a..83c17e2 100644
--- a/debian/ozwcp.1
+++ b/debian/ozwcp.1
@@ -1,4 +1,4 @@
-.TH OZWCP 1 "December 22, 2016"
+.TH OZWCP 1 2016-12-24
 .SH NAME
 ozwcp \- OpenZWave Control Panel
 .SH SYNOPSIS
@@ -7,11 +7,23 @@ ozwcp \- OpenZWave Control Panel
 .RB [ \-p
 .IR port ]
 .SH DESCRIPTION
-OpenZWave Control Panel (\fBozwcp\fP) permits users to query, manage and
+OpenZWave Control Panel (\fBozwcp\fP) permits users to query, manage, and
 monitor Z-Wave nodes and networks. It provides a web-based user interface.
+Some example uses include adding/removing nodes, testing commands,
+and viewing/changing node configuration parameters.
 .PP
 Once started, use a web browser to connect to the host:port that ozwcp
-is listening on. By default this is <\fIhttp://localhost:8090/\fP>.
+is listening on. By default this is <\fI\%http://localhost:8090/\fP>.
+Enter the device path, for example \fI\%/dev/ttyACM0\fP,
+and press "Initialize". Note that many Z-Wave USB sticks act as serial
+devices, and if so, the USB box should not be checked.
+.PP
+\fBozwcp\fP must be able to exclusively read/write to the controller.
+Typically this means running under a user that is a member of
+the device group, for example dialout for serial ports,
+or changing the permissions of the device file.
+Running as root should also work but is not recommended.
+Stop other programs that may be using the device before initializing.
 .SH OPTIONS
 .TP
 .B \-d
@@ -21,5 +33,25 @@ Enable debugging.
 Listen on the specified
 .I port
 instead of 8090.
+.SH FILES
+.TP
+.I /etc/openzwave
+OpenZWave configuration files.
+.TP
+.I /usr/share/openzwave-controlpanel
+Static files for the web server.
+.TP
+.I ozwcache_*.xml
+Cache of the current network configuration, formerly
+\fI\%zwcfg_*.xml\fP.
+.TP
+.I OZW_Log.txt
+OpenZWave log file, useful for debugging.
+.SH AUTHORS
+ozwcp was written by Greg Satz <satz at iranger.com> and maintained by
+Justin Hammond <justin at dynam.ac> and other contributors.
+.PP
+This manual page was written by Dara Adib <daradib at ocf.berkeley.edu>
+for the Debian project (but may be used by others).
 .SH SEE ALSO
 .I /usr/share/doc/openzwave-controlpanel/README

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-iot/openzwave-controlpanel.git