From 0f68a520183ff253969a30f7b1296290a12b8388 Mon Sep 17 00:00:00 2001 From: Mark Hindley Date: Tue, 15 Mar 2022 11:43:04 +0000 Subject: [PATCH] Remove parts of plc/plc.1 not relevant to the Debian package. --- plc/plc.1 | 35 +---------------------------------- 1 file changed, 1 insertion(+), 34 deletions(-) --- a/plc/plc.1 +++ b/plc/plc.1 @@ -1,42 +1,12 @@ .TH plc 1 "November 2013" "open-plc-utils-0.0.3" "Qualcomm Atheros Open Powerline Toolkit" .SH NAME -Qualcomm Atheros Powerline Toolkit - Tools to manage and control HomePlug 1.0 and HomePlug AV devices +plc - Qualcomm Atheros Powerline Toolkit: tools to manage and control HomePlug 1.0 and HomePlug AV devices .SH SYNOPSIS -Qualcomm Atheros provides the \fBPowerline Toolkit\fR to customers free of charge. -The toolkit contains source code and makefiles to build many useful programs. -It also includes example shell scripts that use these programs, in various ways, to interrogate, control and manage QCA powerline devices. -The programs are intended for hardware engineers and software developers, consequently. -They are not intended for end users or computer novices. -Most are compact and simple by design and can be included and executed on embedded platforms having few resources. +A summary of Qualcomm Atheros Powerline Toolkit commands. -.SH INSTALLATION -The Powerline Toolkit is distributed as a tarball named \fBplc-utils-x.x.x.tar.gz\fR or \fBplc-utils-x.x.x.tar.bz2\fR. -Users may unpack the tarball and change to the directory that it creates to inspect the source code and documentation. -To compile the source code, type "\fBmake\fR". -To install the programs, type "\fBmake install\fR". -To install man pages, type "\fBmake manuals\fR". -To uninstall programs and man pages, type "\fBmake uninstall\fR". -To read about the Toolkit, browse file \fBdocbook/index.html\fR and \fBdocbook/toolkit.html\fR. -This package does not automatically install scripts or html pages. -They must be manually copied to the preferred locations. - -.PP -We recommend that you login as root before installing this package; otherwise, you will be prompted for the root password as each component is installed. -On some systems, "\fBsudo make install\fR" will work. -Programs are installed in \fB/usr/local/bin\fR. -Man pages are installed in \fB/usr/share/man/man[1-9]\fR. -If these folders are not correct for your system, or if you want to install in other folders, then edit folder names defined in the \fBMakefile\fR in each package folder. -The package has been compiled in a variety of Linux distributions (debian, ubuntu, redhat, monta vista, amilda) and on MacOSX (10.5, 10.6). -It has also been cross-compiled for MIPS and Freescale iMX35 but QCA does not support general cross compilation efforts. - -.PP -Although this package has been compiled on several platforms, there is no guarantee that it will compile without errors or warnings on non-GNU/Linux platforms. -We continuously update the package but do not attempt to compile or test it on systems other than GNU/Linux and Microsoft VisualStudio .NET. -Some programs have been excluded from the Windows installation for technical reasons. - -.SH BACKGROUND +.SH DESCRIPTION \fBHomePlug 1.0\fR and \fBHomePlug AV\fR are industry standard protocols for powerline communications. Qualcomm Atheros manufactures a family of chipsets that conform to these standards and have various USB, PCI, Ethernet, MII, SPI and UART host interfaces.