Skip to content

Commit fc04d60

Browse files
committed
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.
1 parent bbbd461 commit fc04d60

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

ozwcp.1

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
.TH OZWCP 1 2016-12-24
2+
.SH NAME
3+
ozwcp \- OpenZWave Control Panel
4+
.SH SYNOPSIS
5+
.B ozwcp
6+
.RB [ \-d ]
7+
.RB [ \-p
8+
.IR port ]
9+
.SH DESCRIPTION
10+
OpenZWave Control Panel (\fBozwcp\fP) permits users to query, manage, and
11+
monitor Z-Wave nodes and networks. It provides a web-based user interface.
12+
Some example uses include adding/removing nodes, testing commands,
13+
and viewing/changing node configuration parameters.
14+
.PP
15+
Once started, use a web browser to connect to the host:port that ozwcp
16+
is listening on. By default this is <\fI\%http://localhost:8090/\fP>.
17+
Enter the device path, for example \fI\%/dev/ttyACM0\fP,
18+
and press "Initialize". Note that many Z-Wave USB sticks act as serial
19+
devices, and if so, the USB box should not be checked.
20+
.PP
21+
\fBozwcp\fP must be able to exclusively read/write to the controller.
22+
Typically this means running under a user that is a member of
23+
the device group, for example dialout for serial ports,
24+
or changing the permissions of the device file.
25+
Running as root should also work but is not recommended.
26+
Stop other programs that may be using the device before initializing.
27+
.SH OPTIONS
28+
.TP
29+
.B \-d
30+
Enable debugging.
31+
.TP
32+
.BI \-p\ port
33+
Listen on the specified
34+
.I port
35+
instead of 8090.
36+
.SH FILES
37+
.TP
38+
.I /etc/openzwave
39+
OpenZWave configuration files.
40+
.TP
41+
.I /usr/share/openzwave-controlpanel
42+
Static files for the web server.
43+
.TP
44+
.I ozwcache_*.xml
45+
Cache of the current network configuration, formerly
46+
\fI\%zwcfg_*.xml\fP.
47+
.TP
48+
.I OZW_Log.txt
49+
OpenZWave log file, useful for debugging.
50+
.SH AUTHORS
51+
ozwcp was written by Greg Satz <satz@iranger.com> and maintained by
52+
Justin Hammond <justin@dynam.ac> and other contributors.
53+
.PP
54+
This manual page was written by Dara Adib <daradib@ocf.berkeley.edu>
55+
for the Debian project (but may be used by others).
56+
.SH SEE ALSO
57+
.I /usr/share/doc/openzwave-controlpanel/README

0 commit comments

Comments
 (0)