solicit.1 2.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. .TH solicit 1 "Mar 2014" "plc-utils-2.1.6" "Qualcomm Atheros Powerline Toolkit"
  2. .SH NAME
  3. solicit - Qualcomm Atheros Network Solicitor
  4. .SH SYNOPSIS
  5. .BR solicit
  6. .RI [ options ]
  7. .SH DESCRIPTION
  8. Solicit topology information from powerline network responders.
  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 respond 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. .RB - q
  25. Enter quiet mode.
  26. Progress messages are suppressed.
  27. .TP
  28. .RB - v
  29. Enter verbose mode.
  30. All Etherenet frames sent or received by the program are displayed on stdout.
  31. .TP
  32. -\fBw \fImilliseconds\fR
  33. Wakeup frequency in milliseconds.
  34. This is the time between solicitation messages.
  35. During this time, the program listens for responder announcements.
  36. Values range from 0 through UINT_MAX.
  37. The default is forever.
  38. .TP
  39. -\fB?\fR, --\fBhelp\fR
  40. Print program help summary on stdout.
  41. This option takes precedence over other options on the command line.
  42. .TP
  43. -\fB!\fR, --\fBversion\fR
  44. Print program version information on stdout.
  45. This option takes precedence over other options on the command line.
  46. 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.
  47. .SH REFERENCES
  48. See the Qualcomm Atheros Simple Network Discovery Protocol for more information about \fBsolicitors\fR, \fBresponders\fR and \fBTLVs\fR.
  49. .SH EXAMPLES
  50. The following example starts a solicitor on interface \fBeth0\fR.
  51. .PP
  52. # solicit -i eth0
  53. .SH SEE ALSO
  54. .BR plc ( 1 ),
  55. .BR respond ( 1 ),
  56. .SH CREDITS
  57. Charles Maier <cmaier@qca.qualcomm.com>