src/server: usage/help/doc updates

Make "usage" messages use the same EBNF as the User's Guide;
no angle brackets.  Improve and correct various helptexts.

Specifically for the port commands, clarify that the number
is optional, and omitting it causes the current number to be
displayed.

Don't use "&function"; a function's name is its address.
Remove a couple instances of pointless whitespace; shrink a
few overlong lines.

Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
This commit is contained in:
David Brownell
2010-01-09 00:55:41 -08:00
parent aafd3877e6
commit fc9a2d0e6f
5 changed files with 54 additions and 53 deletions

View File

@@ -619,17 +619,18 @@ COMMAND_HANDLER(handle_exit_command)
static const struct command_registration telnet_command_handlers[] = {
{
.name = "exit",
.handler = &handle_exit_command,
.handler = handle_exit_command,
.mode = COMMAND_EXEC,
.help = "exit telnet session",
},
{
.name = "telnet_port",
.handler = &handle_telnet_port_command,
.handler = handle_telnet_port_command,
.mode = COMMAND_ANY,
.help = "port on which to listen "
"for incoming telnet connections",
.usage = "<port>",
.help = "Specify port on which to listen "
"for incoming telnet connections. "
"No arguments reports telnet port; zero disables.",
.usage = "[port_num]",
},
COMMAND_REGISTRATION_DONE
};