Numerous documentation updates.
authorJoshua Colp <jcolp@digium.com>
Thu, 18 Dec 2008 21:21:44 +0000 (21:21 +0000)
committerJoshua Colp <jcolp@digium.com>
Thu, 18 Dec 2008 21:21:44 +0000 (21:21 +0000)
(closes issue #13970)
Reported by: pkempgen
Patches:
      __20081217_cli_usage_fixes.patch.txt uploaded by blitzrage (license 10)

git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@165792 65c4cc65-6c06-0410-ace0-fbb531ad65f3

apps/app_queue.c
channels/chan_dahdi.c
channels/chan_misdn.c
channels/chan_oss.c
channels/chan_sip.c
pbx/pbx_ael.c

index 49276eb..5b6c439 100644 (file)
@@ -6439,9 +6439,9 @@ static char *handle_queue_pause_member(struct ast_cli_entry *e, int cmd, struct
                e->command = "queue {pause|unpause} member";
                e->usage = 
                        "Usage: queue {pause|unpause} member <member> [queue <queue> [reason <reason>]]\n"
-                       "               Pause or unpause a queue member. Not specifying a particular queue\n"
-                       "               will pause or unpause a member across all queues to which the member\n"
-                       "               belongs.\n";
+                       "       Pause or unpause a queue member. Not specifying a particular queue\n"
+                       "       will pause or unpause a member across all queues to which the member\n"
+                       "       belongs.\n";
                return NULL;
        case CLI_GENERATE:
                return complete_queue_pause_member(a->line, a-> word, a->pos, a->n);
@@ -6513,8 +6513,8 @@ static char *handle_queue_set_member_penalty(struct ast_cli_entry *e, int cmd, s
                e->command = "queue set penalty";
                e->usage = 
                "Usage: queue set penalty <penalty> on <interface> [in <queue>]\n"
-               "Set a member's penalty in the queue specified. If no queue is specified\n"
-               "then that interface's penalty is set in all queues to which that interface is a member\n";
+               "       Set a member's penalty in the queue specified. If no queue is specified\n"
+               "       then that interface's penalty is set in all queues to which that interface is a member\n";
                return NULL;
        case CLI_GENERATE:
                return complete_queue_set_member_penalty(a->line, a->word, a->pos, a->n);
@@ -6575,8 +6575,8 @@ static char *handle_queue_rule_show(struct ast_cli_entry *e, int cmd, struct ast
                e->command = "queue show rules";
                e->usage =
                "Usage: queue show rules [rulename]\n"
-               "Show the list of rules associated with rulename. If no\n"
-               "rulename is specified, list all rules defined in queuerules.conf\n";
+               "       Show the list of rules associated with rulename. If no\n"
+               "       rulename is specified, list all rules defined in queuerules.conf\n";
                return NULL;
        case CLI_GENERATE:
                return complete_queue_rule_show(a->line, a->word, a->pos, a->n);
@@ -6606,7 +6606,7 @@ static char *handle_queue_rule_reload(struct ast_cli_entry *e, int cmd, struct a
                        e->command = "queue reload rules";
                        e->usage = 
                                "Usage: queue reload rules\n"
-                               "Reloads rules defined in queuerules.conf\n";
+                               "       Reloads rules defined in queuerules.conf\n";
                        return NULL;
                case CLI_GENERATE:
                        return NULL;
index b2ea678..c4ac850 100644 (file)
@@ -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 <chan#> <on|off>\n"
-                       "   Sets/resets DND (Do Not Disturb) mode on a channel.\n"
-                       "   Changes take effect immediately.\n"
-                       "   <chan num> is the channel number\n"
-                       "   <on|off> Enable or disable DND mode?\n"
+                       "       Sets/resets DND (Do Not Disturb) mode on a channel.\n"
+                       "       Changes take effect immediately.\n"
+                       "       <chan num> is the channel number\n"
+                       "       <on|off> 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;
index c3dde3c..8ee9291 100644 (file)
@@ -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 [<port> | description <config element> | descriptions [general|ports]]\n"
-               "       Use 0 for <port> to only print the general config.\n";
+                       "       Use 0 for <port> to only print the general config.\n";
                return NULL;
        case CLI_GENERATE:
                return complete_show_config(a);
index b3f0f71..c44d3d8 100644 (file)
@@ -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:
index 700da76..87533cd 100644 (file)
@@ -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 [<name>|all|like <pattern>]|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 [<name>|all|like <pattern>]|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;
index 92e2bd3..f1b8fb0 100644 (file)
@@ -164,7 +164,7 @@ static char *handle_cli_ael_set_debug(struct ast_cli_entry *e, int cmd, struct a
        case CLI_INIT:
                e->command = "ael set debug {read|tokens|macros|contexts|off}";
                e->usage =
-                       "Usage: ael debug {read|tokens|macros|contexts|off}\n"
+                       "Usage: ael set debug {read|tokens|macros|contexts|off}\n"
                        "       Enable AEL read, token, macro, or context debugging,\n"
                        "       or disable all AEL debugging messages.  Note: this\n"
                        "       currently does nothing.\n";