respond.1 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  1. .TH respond 1 "Mar 2014" "plc-utils-2.1.6" "Qualcomm Atheros Powerline Toolkit"
  2. .SH NAME
  3. respond - Qualcomm Atheros Network Responder
  4. .SH SYNOPSIS
  5. .BR respond
  6. .RI [ options ]
  7. .SH DESCRIPTION
  8. Respond to topology requests from powerline network solicitors.
  9. This is a proof-of-concept program that does nothing useful, as it stands.
  10. It is maintained in case there is a need, in the future, to make it do something useful.
  11. It requires one or more instances of program solicit to demonstrate the concept.
  12. The underlying protocol is essentially LLDP.
  13. .PP
  14. This program is part of the Qualcomm Atheros Powerline Toolkit.
  15. See the \fBplc\fR man page for an overview and installation instructions.
  16. .SH OPTIONS
  17. .TP
  18. .RB - i
  19. Select the host Ethernet interface.
  20. All requests are sent via this host interface and only reponses received via this host interface are recognized.
  21. The default interface is \fBeth1\fR because most people use \fBeth0\fR as their principle network connection; however, if environment string "PLC" is defined then it takes precedence over the default interface.
  22. This option then takes precedence over either default.
  23. .TP
  24. -\fBp \fIprofile\fR
  25. The configuration profile name.
  26. The file must have two sections: "\fBStandard\fR" and "\fBSpecific\fR".
  27. Profile elements must conform to the TLV descriptions defined in \fISimple Network Discovery Protocol Programmers Guide\fR.
  28. The program will supply a default value for any omitted configuration profile elements.
  29. See the example profile shown below.
  30. The default filename is "\fBrespond.ini\fR".
  31. .TP
  32. .RB - q
  33. Enter quiet mode.
  34. Progress messages are suppressed.
  35. .TP
  36. .RB - v
  37. Enter verbose mode.
  38. All Etherenet frames sent or received by the program are displayed on stdout.
  39. .TP
  40. -\fBw \fImilliseconds\fR
  41. Wakeup frequency in milliseconds.
  42. This is the time between announcements.
  43. During this time, the program listens for solicitor rquests.
  44. Values range from 0 through UINT_MAX.
  45. '
  46. The default is forever.
  47. .TP
  48. -\fB?\fR, --\fBhelp\fR
  49. Print program help summary on stdout. This option takes precedence over other options on the command line.
  50. .TP
  51. -\fB!\fR, --\fBversion\fR
  52. Print program version information on stdout. This option takes precedence over other options on the command line. Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of the Linux Toolkit you are using.
  53. .SH REFERENCES
  54. See the Qualcomm Atheros Simple Network Discovery Protocol for more information about \fBsolicitors\fR, \fBresponders\fR and \fBTLVs\fR.
  55. .SH EXAMPLES
  56. The following command starts a responder on the local host. The responder will announce and listen on interface \fBeth0\fR. The responder will announce values defined in profile "\fBrespond.ini\fR" by default because option \fB-p\fR is absent.
  57. .PP
  58. # respond -i eth0
  59. .PP
  60. An example profile, "\fBrespond.ini\fR", looks something like this. This configuration file is provided for demonstration purposes only. The source code that parses this file does not support all possible variations these configuration values. See \fIIEEE Standard for Local and metworpolitan networks - Station and Meida Access Control Connectivity Discovery\fR for an explanation of the the value
  61. .PP
  62. # file: respond.ini
  63. # ====================================================================
  64. # This is an example profile for use by program respond; it supports
  65. # the Qualcomm Atheros Simple Network Discovery protocol;
  66. # --------------------------------------------------------------------
  67. [Standard]
  68. Chassis ID = 04AABBCCDDEEFF
  69. Port ID = 03112233445566
  70. Time To Live = 3600
  71. Port Description = The Internet of Things
  72. System Name = WNC Hybrid Router
  73. System Description = Shanghai Public Library Wireless Network
  74. System Capabilities = 00:FF:FF:FF:FF
  75. Management Address = http://www.mamagement.com
  76. [Specific]
  77. Manufacturer = Qualcomm Atheros
  78. Hardware Model = QCA7000
  79. Serial Number = QCA7000-ND25B-0003
  80. HOST MAC = 88:77:66:55:44:33
  81. PLC MAC = 00:B0:52:00:BA:BE
  82. WIFI MAC = AA:BB:CC:DD:EE:FF
  83. WIFI IP = 00:FF:FF:AB:CD
  84. .SH SEE ALSO
  85. .BR plc ( 1 ),
  86. .BR solicit ( 1 ),
  87. .SH CREDITS
  88. Charles Maier <cmaier@qca.qualcomm.com>
  89. '