BIND 10 #2683: BIND10 guide: slightly misleading description of "-a" option for bindctl

[BIND 10 Development]

#2683: BIND10 guide: slightly misleading description of "-a" option for bindctl
-------------------------------------+-------------------------------------
                   Reporter:         |                 Owner:
  jwright                            |                Status:  new
                       Type:  task   |             Milestone:  New Tasks
                   Priority:  very   |              Keywords:
  low                                |             Sensitive:  0
                  Component:         |           Sub-Project:  DNS
  documentation                      |  Estimated Difficulty:  0
               CVSS Scoring:         |           Total Hours:  0
            Defect Severity:  Low    |
Feature Depending on Ticket:         |
        Add Hours to Ticket:  0      |
                  Internal?:  0      |
-------------------------------------+-------------------------------------
 In Section 8.1," bindctl command-line options," it is stated that the -a
 <address> or --address=<address> option sets "IP address that BIND 10's
 b10-cmdctl module is listening on. By default, this is 127.0.0.1."  In
 fact, leaving off the <address> part of the command results in an error:

 bindctl: error: option requires 1 argument

 I was expecting somehow that typing in "./bindctl -a" or "./bindctl
 --address" would result in a session established on the default IP
 address, but I got the error instead.  So, perhaps the wording should just
 be: "IP address that BIND 10's b10-cmdctl module is listening on."  Then,
 in a separate note above the 8.1 section, say something to the effect of
 "The default IP address that bindctl listens on is 127.0.0.1.  This can be
 overridden with the "-a" or "--address" options described below."

-- 
Ticket URL: <http://bind10.isc.org/ticket/2683>
BIND 10 Development <http://bind10.isc.org>
BIND 10 Development