From 6fff9b550d399a0dc205c6e2e4cfb37dd85ee782 Mon Sep 17 00:00:00 2001 From: file Date: Thu, 18 Dec 2008 21:21:44 +0000 Subject: Numerous documentation updates. (closes issue #13970) Reported by: pkempgen Patches: __20081217_cli_usage_fixes.patch.txt uploaded by blitzrage (license 10) git-svn-id: http://svn.digium.com/svn/asterisk/trunk@165792 f38db490-d61c-443f-a65b-d21fe96a405b --- channels/chan_dahdi.c | 20 +++++++++++++------- channels/chan_misdn.c | 2 +- channels/chan_oss.c | 5 +++-- channels/chan_sip.c | 16 ++++++++-------- 4 files changed, 25 insertions(+), 18 deletions(-) (limited to 'channels') diff --git a/channels/chan_dahdi.c b/channels/chan_dahdi.c index b2ea67824..c4ac8506d 100644 --- a/channels/chan_dahdi.c +++ b/channels/chan_dahdi.c @@ -12030,7 +12030,9 @@ static char *handle_pri_show_debug(struct ast_cli_entry *e, int cmd, struct ast_ switch (cmd) { case CLI_INIT: e->command = "pri show debug"; - e->usage = "Show the debug state of pri spans\n"; + e->usage = + "Usage: pri show debug\n" + " Show the debug state of pri spans\n"; return NULL; case CLI_GENERATE: return NULL; @@ -12064,7 +12066,9 @@ static char *handle_pri_version(struct ast_cli_entry *e, int cmd, struct ast_cli switch (cmd) { case CLI_INIT: e->command = "pri show version"; - e->usage = "Show libpri version information\n"; + e->usage = + "Usage: pri show version\n" + "Show libpri version information\n"; return NULL; case CLI_GENERATE: return NULL; @@ -12888,10 +12892,10 @@ static char *dahdi_set_dnd(struct ast_cli_entry *e, int cmd, struct ast_cli_args e->command = "dahdi set dnd"; e->usage = "Usage: dahdi set dnd \n" - " Sets/resets DND (Do Not Disturb) mode on a channel.\n" - " Changes take effect immediately.\n" - " is the channel number\n" - " Enable or disable DND mode?\n" + " Sets/resets DND (Do Not Disturb) mode on a channel.\n" + " Changes take effect immediately.\n" + " is the channel number\n" + " Enable or disable DND mode?\n" ; return NULL; case CLI_GENERATE: @@ -13572,7 +13576,9 @@ static char *handle_ss7_version(struct ast_cli_entry *e, int cmd, struct ast_cli switch (cmd) { case CLI_INIT: e->command = "ss7 show version"; - e->usage = "Show the libss7 version\n"; + e->usage = + "Usage: ss7 show version\n" + " Show the libss7 version\n"; return NULL; case CLI_GENERATE: return NULL; diff --git a/channels/chan_misdn.c b/channels/chan_misdn.c index c3dde3cf6..8ee929176 100644 --- a/channels/chan_misdn.c +++ b/channels/chan_misdn.c @@ -996,7 +996,7 @@ static char *handle_cli_misdn_show_config(struct ast_cli_entry *e, int cmd, stru e->command = "misdn show config"; e->usage = "Usage: misdn show config [ | description | descriptions [general|ports]]\n" - " Use 0 for to only print the general config.\n"; + " Use 0 for to only print the general config.\n"; return NULL; case CLI_GENERATE: return complete_show_config(a); diff --git a/channels/chan_oss.c b/channels/chan_oss.c index b3f0f71bc..c44d3d845 100644 --- a/channels/chan_oss.c +++ b/channels/chan_oss.c @@ -877,8 +877,9 @@ static char *console_cmd(struct ast_cli_entry *e, int cmd, struct ast_cli_args * switch (cmd) { case CLI_INIT: e->command = CONSOLE_VIDEO_CMDS; - e->usage = "Usage: " CONSOLE_VIDEO_CMDS "...\n" - " Generic handler for console commands.\n"; + e->usage = + "Usage: " CONSOLE_VIDEO_CMDS "...\n" + " Generic handler for console commands.\n"; return NULL; case CLI_GENERATE: diff --git a/channels/chan_sip.c b/channels/chan_sip.c index 700da766b..87533cdba 100644 --- a/channels/chan_sip.c +++ b/channels/chan_sip.c @@ -13673,9 +13673,9 @@ static char *sip_prune_realtime(struct ast_cli_entry *e, int cmd, struct ast_cli if (cmd == CLI_INIT) { e->command = "sip prune realtime [peer|all]"; e->usage = - "Usage: sip prune realtime [peer [|all|like ]|all]\n" - " Prunes object(s) from the cache.\n" - " Optional regular expression pattern is used to filter the objects.\n"; + "Usage: sip prune realtime [peer [|all|like ]|all]\n" + " Prunes object(s) from the cache.\n" + " Optional regular expression pattern is used to filter the objects.\n"; return NULL; } else if (cmd == CLI_GENERATE) { if (a->pos == 4 && !strcasecmp(a->argv[3], "peer")) { @@ -14745,10 +14745,10 @@ static char *sip_show_channels(struct ast_cli_entry *e, int cmd, struct ast_cli_ if (cmd == CLI_INIT) { e->command = "sip show {channels|subscriptions}"; e->usage = - "Usage: sip show channels\n" - " Lists all currently active SIP calls (dialogs).\n" - "Usage: sip show subscriptions\n" - " Lists active SIP subscriptions.\n"; + "Usage: sip show channels\n" + " Lists all currently active SIP calls (dialogs).\n" + "Usage: sip show subscriptions\n" + " Lists active SIP subscriptions.\n"; return NULL; } else if (cmd == CLI_GENERATE) return NULL; @@ -15463,7 +15463,7 @@ static char *sip_set_history(struct ast_cli_entry *e, int cmd, struct ast_cli_ar case CLI_INIT: e->command = "sip set history {on|off}"; e->usage = - "Usage: sip history {on|off}\n" + "Usage: sip set history {on|off}\n" " Enables/Disables recording of SIP dialog history for debugging purposes.\n" " Use 'sip show history' to view the history of a call number.\n"; return NULL; -- cgit v1.2.3