Improve command line help page

[adefazio]

It doesn't actually say that you need to use colons between parts, or anything like that. Perhaps copy some of the github docs to the command line docs.

[olorin]

I thought it did - is Filter using the following syntax: CLIENT[:FLAVOUR[:NAME]] insufficiently clear? Any suggestions for improving it?

[adefazio]

Where does it say that when you run it? I just see the help page:

Usage: box [-e|--environment ENV] ((-v|--version) | COMMAND)

Available options:
  -e,--environment ENV     Use an alternate box store / environment
  -v,--version             Version information
  -h,--help                Show this help text

Available commands:
  ip                       Get the IP address of a box.
  ssh                      SSH to a box.
  rsh                      SSH to a box with a shell interface compatible with
                           rsync.
  rsync                    SSH to a box.
  ls                       List available boxes.

'''

[domdere]

% box ssh --help
Usage: box ssh [-s|--secure] FILTER [SSH_ARGUMENTS]
  SSH to a box.

Available options:
  -s,--secure              Use a 2FA-enabled gateway.
  FILTER                   Filter using the following syntax:
                           CLIENT[:FLAVOUR[:NAME]]
  SSH_ARGUMENTS            Extra arguments to pass to ssh.
  -h,--help                Show this help text

[adefazio]

Ok. I would be happy with a line at the bottom of the help just saying something like "Use 'box --help' for help on specific commands"
git --help has something similar.