plclog.1.html 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129
  1. <?xml version='1.0' encoding='iso-8859-1'?>
  2. <!doctype html public '-//W3C//DTD XHTML 1.0 Strict//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
  3. <html xmlns='http://www.w3c.org/1999/xhtml' lang='en-us'>
  4. <head>
  5. <title>
  6. plclog.1
  7. </title>
  8. <meta http-equiv='content-type' content='text/html;iso-8859-1'/>
  9. <meta name='generator' content='motley-tools 1.9.4 13:40:33 Feb 18 2015'/>
  10. <meta name='author' content='cmaier@cmassoc.net'/>
  11. <meta name='robots' content='noindex,nofollow'/>
  12. <link href='toolkit.css' rel='stylesheet' type='text/css'/>
  13. </head>
  14. <body>
  15. <div class='headerlink'>
  16. [<a href='plclist.1.html' title=' plclist.1 '>PREV</a>]
  17. [<a href='toolkit.html' title=' Index '>HOME</a>]
  18. [<a href='plcmdio16.1.html' title=' plcmdio16.1 '>NEXT</a>]
  19. </div>
  20. <pre>
  21. plclog(1) Qualcomm Atheros Open Powerline Toolkit plclog(1)
  22. NAME
  23. plclog - Qualcomm Atheros Log Retrieval Utility
  24. SYNOPSIS
  25. plclog [options] [device] [device] [...] [&gt;stdout]
  26. DESCRIPTION
  27. Read and print the device watchdog and checkpoint report on stdout for subsequent analysis by Atheros Technical Support.
  28. Report output is in XML format and contains base-64 encoded binary data returned by the device. Aside from the XML tags,
  29. output is not in human readable format.
  30. This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
  31. instructions.
  32. OPTIONS
  33. -c Specify custom watchdog report.
  34. -C Clear the report after reading.
  35. -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
  36. program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
  37. -x Print the report in XML format. The default is raw (or binary) format.
  38. -i interface
  39. Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
  40. this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
  41. network connection; however, if environment string &quot;PLC&quot; is defined then it takes precedence over the default
  42. interface. This option then takes precedence over either default.
  43. -q Suppresses status messages on stderr.
  44. -v Print additional information on stdout. In particular, this option dumps incoming and outgoing packets which can
  45. be saved as text files for reference.
  46. -?,--help
  47. Print program help summary on stdout. This option takes precedence over other options on the command line.
  48. -?,--version
  49. Print program version information on stdout. This option takes precedence over other options on the command line.
  50. Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
  51. the Linux Toolkit you are using.
  52. ARGUMENTS
  53. device The MAC address of some powerline device. More than one address may be specified. If more than one address is
  54. specified then operations are performed on each device in turn. The default address is local. See DEVICES for
  55. information about symbolic device addresses.
  56. LOGFILES
  57. Log files are save in binary format by default but they can also be saved in XML format by adding option -x to the com‐
  58. mand line. By convention, binary log files have a .log extension and XML log files have a .xlog extension. The exten‐
  59. sion is not critical but it helps us determine the format before we open the file.
  60. DEVICES
  61. Powerline devices use Ethernet Media Access Control (MAC) addresses. MAC addresses are 12 hexadecimal digits
  62. (0123456789ABCDEFabcdef) in upper, lower or mixed case. Individual octets may be separated by colons, for clarity, but
  63. not all octets need to be seperated. For example, &quot;00b052000001&quot;, &quot;00:b0:52:00:00:01&quot; and &quot;00b052:000001&quot; are valid and
  64. equivalent.
  65. The following MAC addresses are special and may be expressed by name instead of number.
  66. all Equivalent to &quot;broadcast&quot;, described next.
  67. broadcast
  68. A synonym for the standard Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or
  69. foreign will respond to this address.
  70. local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
  71. Atheros devices will recognize this address but remote and foreign devices will not. A remote device is any
  72. device at the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
  73. REFERENCES
  74. See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
  75. DISCLAIMER
  76. Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Atheros Communications,
  77. Ocala FL USA. Consequently, public information is not available. Atheros Communications reserves the right to modify
  78. message structure or content in future firmware releases without any obligation to notify or compensate users of this
  79. program.
  80. EXAMPLES
  81. The following example reads the Watchdog and Checkpoint Report from device 00:B0:52:BA:BE:02 and prints them on stdout in
  82. XML format. The output contains data segments formatted in base-64 notation which preserved data integrity when read or
  83. transmitted in text format.
  84. # plclog 00:B0:52:BA:BE:02
  85. The next example does the same thing but pipes output to file temp.log. Atheros recommends using a .log extension for
  86. compatibility with the WIndows Device Manager.
  87. # plclog 00:B0:52:BA:BE:02 &gt; temp.log
  88. SEE ALSO
  89. amp(1), plctool(1)
  90. CREDITS
  91. Charles Maier &lt;cmaier@qca.qualcomm.com&gt;
  92. open-plc-utils-0.0.3 Mar 2014 plclog(1)
  93. </pre>
  94. <div class='footerlink'>
  95. [<a href='plclist.1.html' title=' plclist.1 '>PREV</a>]
  96. [<a href='toolkit.html' title=' Index '>HOME</a>]
  97. [<a href='plcmdio16.1.html' title=' plcmdio16.1 '>NEXT</a>]
  98. </div>
  99. </body>
  100. </html>