Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Some minor fixes for several manpages #106

Merged
merged 7 commits into from
May 21, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions mdio/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ mdioblock
mdioblock2
mdiodump
mdiogen
mdio.bin
2 changes: 1 addition & 1 deletion mdio/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ LDFLAGS+=
TRASH=*.o *.obj *.exe t t.* *~ *.[0-9][0-9][0-9]
FILES=Makefile *.mak *.sh *.c *.h
TOOLS=mdioblock mdioblock2 mdiodump mdiogen
PAGES=mdioblock.1 mdioblock2.1 mdiodump.1
PAGES=mdioblock.1 mdioblock2.1 mdiodump.1 mdiogen.1

# ====================================================================
# pseudo targets;
Expand Down
47 changes: 47 additions & 0 deletions mdio/mdiogen.1
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
.TH mdiogen 1 "November 2013" "open-plc-utils-0.0.3" "Qualcomm Atheros Open Powerline Toolkit"

.SH NAME
mdiogen - Qualcomm Atheros MDIO Custom Module Generator

.SH SYNOPSIS
.BR mdiogen

.SH DESCRIPTION
Produces an MDIO program block from a fixed compiled-in array and outputs it
to fixed file named \fBmdio.bin\fR.

.PP
This program is part of the Qualcomm Atheros Powerline Toolkit.
See the \fBPLC\fR man page for an overview and installation instructions.

.SH REFERENCES
See the Qualcomm Atheros \fIHomePlug AV Firmware Technical Reference Manual\fR for information about
generic MDIO register instruction.
See the Qualcomm Atheros \fIAR8236 Six-Port Fast Ethernet Switch Data Sheet\fR for detailed
information about AR8236 specific MDIO registers and instructions.

.SH DISCLAIMER
Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to
Qualcomm Atheros, Ocala FL USA.
Consequently, public information may not be available.
Qualcomm Atheros reserves the right to modify message structure and content in future firmware
releases without any obligation to notify or compensate users of this program.

.SH EXAMPLES
None.

.SH SEE ALSO
.BR amp ( 1 ),
.BR int6kmod ( 1 ),
.BR int6kmdio ( 1 ),
.BR int6kmdio2 ( 1 ),
.BR mdioblock ( 1 ),
.BR mdioblock2 ( 1 ),
.BR mdiogen ( 1 ),
.BR plcmdio16 ( 1 ),
.BR plcmdio32 ( 1 )

.SH CREDITS
Nathaniel Houghton
Charles Maier
Marc Bertola
3 changes: 2 additions & 1 deletion plc/coqos_man.1
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,8 @@ A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA
All local Atheros devices recognize this address but remote and foreign devices do not.
A remote device is any device at the far end of a powerline connection.
A foreign device is any device not manufactured by Atheros.
..SH REFERENCES

.SH REFERENCES
See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.

.SH DISCLAIMER
Expand Down
4 changes: 2 additions & 2 deletions plc/mdustats.1
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.TH mdustats 1 "November 2013" "open-plc-utils-0.0.3" "Qualcomm Atheros Open Powerline Toolkit"

.SH NAME
mdustats
mdustats - MDU traffic statistics

.SH SYNOPSIS
.BR mdustats
Expand All @@ -11,7 +11,7 @@ mdustats
[...]

.SH DESCRIPTION
Collect and display MDU traffic statisitcs using the Qualcomm Atheros vendor specific VS_MDU_TRAFFIC_STATS message.
Collect and display MDU traffic statistics using the Qualcomm Atheros vendor specific VS_MDU_TRAFFIC_STATS message.

.PP
This program is part of the Qualcomm Atheros Powerline Toolkit.
Expand Down
2 changes: 1 addition & 1 deletion plc/plc.1
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.TH plc 1 "November 2013" "open-plc-utils-0.0.3" "Qualcomm Atheros Open Powerline Toolkit"

.SH NAME
Qualcomm Atheros Powerline Toolkit
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.
Expand Down
13 changes: 5 additions & 8 deletions slac/evse.1
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ See the \fIHomePlug Green PHY Specification Release Version 1.1\fR for more info
Signal Level Attenuation Characterization (SLAC) enables a station to measure the signal level of its transmission at other stations in the network.
It is designed for automotive applications where there are multiple plug-in vehicle (PEVs) and electric vehicle supply equipment (EVSE) on the network.
The PEV signal level is measured at multiple EVSEs to determine which EVSE the PEV is actually plugged into.
The process leading to this determination is called "\fBGreen PHY PEV-EVSE Association\fB" (GreenPPEA).
The process leading to this determination is called "\fBGreen PHY PEV-EVSE Association\fR" (GreenPPEA).

.PP
This program is part of the Qualcomm Atheros Powerline Toolkit.
Expand Down Expand Up @@ -86,18 +86,18 @@ Use this option when sending screen dumps to Atheros Technical Support so that t
.SH PROFILE
The default configuration profile for this program is "\fBevse.ini\fR".
The default profile section is "\fBdefault\fR".
Users may create addition profiles and reference them with option \fB-p\fr or add additional sections to an existing profiles and reference them with option \fB-s\fR.
Users may create addition profiles and reference them with option \fB-p\fR or add additional sections to an existing profiles and reference them with option \fB-s\fR.

.TP
.TP
.B Time to Sound
The time in 100 millisecond increments for all msounds to arrive at the msound target.
The msound target may proceed with attenuation characterization computations should all msounds fail to arrive within this period.
This value is read but not used by program \fBpev\fR or program \fBevse\fR.
This value is the same as CM_SLAC_PARAM.CNF.TIME_OUT.
The default value is \fB10\fR which represents 1000 milliseconds.

.TP
.B Number of Sounds
.TP
.B Number of Sounds

.TP
The total number of msounds that will be sent to the msound target.
Expand Down Expand Up @@ -165,6 +165,3 @@ Use option \fB-P\fR to produce a template profile, if one is needed.

.SH CREDITS
Charles Maier
'
'

5 changes: 2 additions & 3 deletions slac/pev.1
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ See the \fIHomePlug Green PHY Specification Release Version 1.1\fR for more info
Signal Level Attenuation Characterization (SLAC) enables a station to measure the signal level of its transmission at other stations in the network.
It is designed for automotive applications where there are multiple plug-in vehicle (PEVs) and electric vehicle supply equipment (EVSE) on the network.
The PEV signal level is measured at multiple EVSEs to determine which EVSE the PEV is actually plugged into.
The process leading to this determination is called "\fBGreen PHY PEV-EVSE Association\fB" (GreenPPEA).
The process leading to this determination is called "\fBGreen PHY PEV-EVSE Association\fR" (GreenPPEA).

.PP
This program is part of the Qualcomm Atheros Powerline Toolkit.
Expand Down Expand Up @@ -84,7 +84,7 @@ Use this option when sending screen dumps to Atheros Technical Support so that t
.SH PROFILES
The default configuration profile for this program is "\fBpev.ini\fR".
The default profile section is "\fBdefault\fR".
Users may create addition profiles and reference them with option \fB-p\fr or add additional sections to an existing profiles and reference them with option \fB-s\fR.
Users may create addition profiles and reference them with option \fB-p\fR or add additional sections to an existing profiles and reference them with option \fB-s\fR.

.TP
.B Attenuation Theshold
Expand Down Expand Up @@ -148,4 +148,3 @@ Use option \fB-P\fR to produce a template profile, if one is needed.

.SH CREDITS
Charles Maier