coqos_rel.1 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123
  1. .TH coqos_rel 1 "Mar 2014" "plc-utils-2.1.6" "Qualcomm Atheros Powerline Toolkit"
  2. .SH NAME
  3. coqos_rel - Release Bandwidth Management
  4. .SH SYNOPSIS
  5. .BR coqos_rel
  6. .RI [ options ]
  7. .IR cid
  8. .RI [ device ]
  9. [...]
  10. .SH DESCRIPTION
  11. .B This page is under construction.
  12. .PP
  13. Instructs one or more devices to stop managing a stream.
  14. Use this program when bandwidth management is no longer needed or wanted.
  15. Use program \fBcoqos_mod\fR to suspend and resume bandwidth management of a stream.
  16. .PP
  17. This program is part of the Qualcomm Atheros Powerline Toolkit.
  18. See the \fBplc\fR man page for an overview and installation instructions.
  19. .SH OPTIONS
  20. .TP
  21. .RB - e
  22. Redirects stderr messages to stdout.
  23. By convention status and error messages are printed on stderr while primary program output is printed on stdout.
  24. This option prints all output on stdout in cases where this is desired.
  25. .TP
  26. -\fBi \fIinterface\fR
  27. Select the host Ethernet interface.
  28. All requests are sent via this host interface and only reponses received via this host interface are recognized.
  29. 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.
  30. This option then takes precedence over either default.
  31. .TP
  32. .RB - q
  33. Suppresses status messages on stderr.
  34. .TP
  35. .RB - r
  36. Display relative memory offsets on output.
  37. This option is the default.
  38. .TP
  39. .RB - v
  40. Prints additional information on stdout.
  41. In particular, this option dumps outgoing Ethernet packets on stdout.
  42. .TP
  43. .RB - ? ,-- help
  44. Displays program help information on stderr.
  45. This option takes precedence over all other options on the command line except version information.
  46. .TP
  47. .RB - ! ,-- version
  48. Displays program version information on stderr.
  49. This option takes precedence over all other options on the command line except help information.
  50. Use this option when sending screen dumps to Atheros technical staff.
  51. .SH ARGUMENTS
  52. .TP
  53. .IR cid
  54. The connection identifier of the affected stream.
  55. .TP
  56. .IR device
  57. The MAC address of some powerline device.
  58. More than one address may be specified on the command line.
  59. If more than one address is specified then operations are performed on each device in turn.
  60. The default address is "\fBlocal\fR".
  61. See \fBDEVICES\fR for more information.
  62. .SH DEVICES
  63. Ethernet MAC addresses are expressed as six hexadecimal octets optionally separated by colon.
  64. For example, the Qualcomm Atheros Local Management Address (LMA) of "00b052000001" may also be entered as "00:b0:52:00:00:01" or "00b052:000001".
  65. Addresses are case insensitive and quotes are optional.
  66. In addition, some special addresses may be entered by name rather than number where names are case sensitive.
  67. .TP
  68. .BR all
  69. A synonym for the "broadcast" address, described next.
  70. .TP
  71. .BR broadcast
  72. A synonym for the Ethernet broadcast address, \fBFF:FF:FF:FF:FF:FF\fR.
  73. All devices, whether local, remote or foreign will respond to this address.
  74. .TP
  75. .BR local
  76. A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), \fB00:B0:52:00:00:01\fR.
  77. All local Atheros devices recognize this address but remote and foreign devices do not.
  78. A remote device is any device at the far end of a powerline connection.
  79. A foreign device is any device not manufactured by Atheros.
  80. .SH REFERENCES
  81. See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
  82. .SH DISCLAIMER
  83. Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL USA.
  84. Consequently, public information may not be available.
  85. 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.
  86. .SH EXAMPLES
  87. The next example instructs device \fB00:B0:52:BA:BE"01\fR to release stream \fB803\fR. The stream will the remain unmanaged indefinitely.
  88. .PP
  89. # coqos_rel 803 00:B0:52:BA:BE:01
  90. .SH SEE ALSO
  91. .BR coqos_add ( 1 ),
  92. .BR coqos_info ( 1 ),
  93. .BR coqos_man ( 1 ),
  94. .BR coqos_mod ( 1 )
  95. .SH CREDITS
  96. Bill Wike <bill.wike@qca.qualcomm.com>
  97. Nathaniel Houghton <nhoughto@qca.qualcomm.com>
  98. Charles Maier <cmaier@qca.qualcomm.com>
  99. "