From fc04d606f6da6a8f0ecd68057eefba5da8c9848e Mon Sep 17 00:00:00 2001 From: Dara Adib Date: Thu, 20 Apr 2017 00:39:52 -0400 Subject: [PATCH 1/2] Add ozwcp man page Import ozwcp man page as written for the Debian project on 2016-12-24. The file paths may need to be changed as they are somewhat specific to Debian/Ubuntu. --- ozwcp.1 | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 ozwcp.1 diff --git a/ozwcp.1 b/ozwcp.1 new file mode 100644 index 0000000..83c17e2 --- /dev/null +++ b/ozwcp.1 @@ -0,0 +1,57 @@ +.TH OZWCP 1 2016-12-24 +.SH NAME +ozwcp \- OpenZWave Control Panel +.SH SYNOPSIS +.B ozwcp +.RB [ \-d ] +.RB [ \-p +.IR port ] +.SH DESCRIPTION +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 <\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 +Enable debugging. +.TP +.BI \-p\ port +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 and maintained by +Justin Hammond and other contributors. +.PP +This manual page was written by Dara Adib +for the Debian project (but may be used by others). +.SH SEE ALSO +.I /usr/share/doc/openzwave-controlpanel/README From 597599c987b8f6070e913a837677a29c6ed85679 Mon Sep 17 00:00:00 2001 From: Dara Adib Date: Thu, 20 Apr 2017 00:48:32 -0400 Subject: [PATCH 2/2] Remove Debian paths from man page --- ozwcp.1 | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/ozwcp.1 b/ozwcp.1 index 83c17e2..7c826e1 100644 --- a/ozwcp.1 +++ b/ozwcp.1 @@ -1,4 +1,4 @@ -.TH OZWCP 1 2016-12-24 +.TH OZWCP 1 2017-04-20 .SH NAME ozwcp \- OpenZWave Control Panel .SH SYNOPSIS @@ -35,12 +35,9 @@ Listen on the specified instead of 8090. .SH FILES .TP -.I /etc/openzwave +.I config 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. @@ -54,4 +51,4 @@ Justin Hammond and other contributors. This manual page was written by Dara Adib for the Debian project (but may be used by others). .SH SEE ALSO -.I /usr/share/doc/openzwave-controlpanel/README +.I README