Low: Tools: Massage help text contents and output

Mercurial revision: 3aa095660d4c7d3d0f0b99c4d541de9606c0559c

Author: beekhof

tools/Makefile.am

@@ -44,6 +44,7 @@ sbin_PROGRAMS		= crmadmin cibadmin crm_node crm_attribute crm_resource crm_verif
 if BUILD_HELP
 man8_MANS =	$(sbin_PROGRAMS:%=%.8)
 %.8:	%
+	$(abs_builddir)/$< --help
 	help2man --output $@ --no-info --section 8 --name "Part of the Pacemaker cluster resource manager" $(abs_builddir)/$<
 endif
 

tools/attrd_updater.c

@@ -39,26 +39,26 @@ char command = 'q';
 
 static struct crm_option long_options[] = {
     /* Top-level Options */
-    {"help",    0, 0, '?', "This text"},
-    {"version", 0, 0, '$', "Version information"  },
-    {"verbose", 0, 0, 'V', "Increase debug output\n"},
+    {"help",    0, 0, '?', "\tThis text"},
+    {"version", 0, 0, '$', "\tVersion information"  },
+    {"verbose", 0, 0, 'V', "\tIncrease debug output\n"},
 
     {"name",    1, 0, 'n', "The attribute's name"},
 
-    {"-spacer-",1, 0, '-', "\nCommands:\n"},
+    {"-spacer-",1, 0, '-', "\nCommands:"},
     {"update",  1, 0, 'U', "Update the attribute's value in attrd.  If this causes the value to change, it will also be updated in the cluster configuration"},
     {"query",   0, 0, 'Q', "\tQuery the attribute's value from attrd"},
     {"delete",  0, 0, 'D', "\tDelete the attribute in attrd.  If a value was previously set, it will also be removed from the cluster configuration"},
     {"refresh", 0, 0, 'R', "\t(Advanced) Force the attrd daemon to resend all current values to the CIB\n"},    
 
-    {"-spacer-",1, 0, '-', "\nAdditional options:\n"},
+    {"-spacer-",1, 0, '-', "\nAdditional options:"},
+    {"lifetime",1, 0, 'l', "Lifetime of the node attribute.  Allowed values: forever, reboot"},
     {"delay",   1, 0, 'd', "The time to wait (dampening) in seconds further changes occur"},
     {"set",     1, 0, 's', "(Advanced) The attribute set in which to place the value"},
-    {"section", 1, 0, 'S', "(Advanced) The section in which to place the value\n"},
-
 
     /* Legacy options */
     {"update",  1, 0, 'v', NULL, 1},
+    {"section", 1, 0, 'S', NULL, 1},
     {0, 0, 0, 0}
 };
 
@@ -70,7 +70,7 @@ main(int argc, char ** argv)
     int flag;
 
     crm_log_init("attrd_updater", LOG_ERR, FALSE, FALSE, argc, argv);
-    crm_set_options("?$Vn:v:d:s:S:RDQU:", "{command} -n {attribute} [options]", long_options, "Tool for updating cluster node attributes");
+    crm_set_options("?$Vn:v:d:s:S:RDQU:l:", "command -n attribute [options]", long_options, "Tool for updating cluster node attributes");
 
     if(argc < 2) {
 	crm_help('?', LSB_EXIT_EINVAL);
@@ -98,6 +98,7 @@ main(int argc, char ** argv)
 	    case 'd':
 		attr_dampen = crm_strdup(optarg);
 		break;
+	    case 'l':
 	    case 'S':
 		attr_section = crm_strdup(optarg);
 		break;

tools/ccm_epoche.c

@@ -61,10 +61,10 @@ gboolean ccm_age_connect(int *ccm_fd);
 
 static struct crm_option long_options[] = {
     /* Top-level Options */
-    {"help",       0, 0, '?', "This text"},
-    {"version",    0, 0, '$', "Version information"  },
-    {"verbose",    0, 0, 'V', "Increase debug output"},
-    {"quiet",      0, 0, 'Q', "Essential output only"},
+    {"help",       0, 0, '?', "\tThis text"},
+    {"version",    0, 0, '$', "\tVersion information"  },
+    {"verbose",    0, 0, 'V', "\tIncrease debug output"},
+    {"quiet",      0, 0, 'Q', "\tEssential output only"},
 
     {"-spacer-",   1, 0, '-', "\nStack:", SUPPORT_HEARTBEAT},
     {"openais",    0, 0, 'A', "\tOnly try connecting to an OpenAIS-based cluster", SUPPORT_HEARTBEAT},
@@ -94,8 +94,8 @@ main(int argc, char ** argv)
 
     crm_peer_init();
     crm_log_init(basename(argv[0]), LOG_WARNING, FALSE, FALSE, argc, argv);
-    crm_set_options("?V$qepHR:s:SN:l:", "[-?$V] {command} [options]", long_options,
-		    "Tool for displaying node-level information");
+    crm_set_options("?V$qepHR:s:SN:l:", "command [options]", long_options,
+		    "Tool for displaying low-level node information");
 
     while (flag >= 0) {
 	flag = crm_get_option(argc, argv, &option_index);

tools/cib_shadow.c

@@ -122,25 +122,27 @@ static void shadow_teardown(char *name)
 
 static struct crm_option long_options[] = {
     /* Top-level Options */
-    {"help",           0, 0, '?', "This text"},
-    {"version",        0, 0, '$', "Version information"  },
-    {"verbose",        0, 0, 'V', "Increase debug output\n"},
+    {"help",    0, 0, '?', "\t\tThis text"},
+    {"version", 0, 0, '$', "\t\tVersion information"  },
+    {"verbose", 0, 0, 'V', "\t\tIncrease debug output"},
 
-    {"create",		required_argument, NULL, 'c', "\tCreate the named shadow copy of the active cluster configuration"},
-    {"create-empty",	required_argument, NULL, 'e', "Create the named shadow copy with an empty cluster configuration\n"},
-
-    {"which",   no_argument,       NULL, 'w', "\tIndicate the active shadow copy"},
-    {"display", no_argument,       NULL, 'p', "\tDisplay the contents of the shadow copy"},
-    {"edit",    no_argument,       NULL, 'E', "\tEdit the contents of the named shadow copy with your favorite $EDITOR"},
-    {"diff",    no_argument,       NULL, 'd', "\tDisplay the changes in the shadow copy\n"},
+    {"-spacer-",	1, 0, '-', "\nQueries:"},
+    {"which",   no_argument,       NULL, 'w', "\t\tIndicate the active shadow copy"},
+    {"display", no_argument,       NULL, 'p', "\t\tDisplay the contents of the shadow copy"},
+    {"edit",    no_argument,       NULL, 'E', "\t\tEdit the contents of the named shadow copy with your favorite $EDITOR"},
+    {"diff",    no_argument,       NULL, 'd', "\t\tDisplay the changes in the shadow copy\n"},
 
-    {"commit",  required_argument, NULL, 'C', "Upload the contents of the named shadow copy to the cluster"},
-    {"delete",  required_argument, NULL, 'D', "Delete the contents of the named shadow copy"},
-    {"reset",   required_argument, NULL, 'r', "Recreate the named shadow copy from the active cluster configuration\n"},
+    {"-spacer-",	1, 0, '-', "\nCommands:"},
+    {"create",		required_argument, NULL, 'c', "\tCreate the named shadow copy of the active cluster configuration"},
+    {"create-empty",	required_argument, NULL, 'e', "Create the named shadow copy with an empty cluster configuration"},
+    {"commit",  required_argument, NULL, 'C', "\tUpload the contents of the named shadow copy to the cluster"},
+    {"delete",  required_argument, NULL, 'D', "\tDelete the contents of the named shadow copy"},
+    {"reset",   required_argument, NULL, 'r', "\tRecreate the named shadow copy from the active cluster configuration"},
+    {"switch",  required_argument, NULL, 's', "\t(Advanced) Switch to the named shadow copy"},
 
-    {"force",	no_argument, NULL, 'f', "\t(Advanced) Force the action to be performed"},
-    {"batch",   no_argument, NULL, 'b', "\t(Advanced) Don't spawn a new shell" },
-    {"switch",  required_argument, NULL, 's', "(Advanced) Switch to the named shadow copy"},
+    {"-spacer-",	1, 0, '-', "\nAdditional Options:"},
+    {"force",	no_argument, NULL, 'f', "\t\t(Advanced) Force the action to be performed"},
+    {"batch",   no_argument, NULL, 'b', "\t\t(Advanced) Don't spawn a new shell" },
 
 	{0, 0, 0, 0}
 };
@@ -159,7 +161,7 @@ main(int argc, char **argv)
     int option_index = 0;
 
     crm_log_init("crm_shadow", LOG_CRIT, FALSE, FALSE, argc, argv);
-    crm_set_options("V$?bfwc:dr:C:D:ps:Ee:", NULL, long_options,
+    crm_set_options("V$?bfwc:dr:C:D:ps:Ee:", "(query|command) [modifiers]", long_options,
 		    "Perform configuration changes in a sandbox before updating the live cluster.\n"
 		    "  Sets up an environment in which configuration tools (cibadmin, crm_resource, etc) work"
 		    " offline instead of against a live cluster, allowing changes to be previewed and tested"

tools/cibadmin.c

@@ -77,28 +77,28 @@ cib_t *the_cib = NULL;
 gboolean force_flag = FALSE;
 
 static struct crm_option long_options[] = {
-    {"help",    0, 0, '?', "This text"},
-    {"version", 0, 0, '$', "Version information"  },
-    {"verbose", 0, 0, 'V', "Increase debug output\n"},
+    {"help",    0, 0, '?', "\tThis text"},
+    {"version", 0, 0, '$', "\tVersion information"  },
+    {"verbose", 0, 0, 'V', "\tIncrease debug output\n"},
 
     {"-spacer-",    0, 0, '-', "Commands:"},
     {"upgrade",     0, 0, 'u', "\tUpgrade the configuration to the latest syntax"},
     {"query",       0, 0, 'Q', "\tQuery the contents of the CIB"},
     {"erase",       0, 0, 'E', "\tErase the contents of the whole CIB"},
+    {"bump",        0, 0, 'B', "\tIncrease the CIB's epoch value by 1"},
     {"create",      0, 0, 'C', "\tCreate an object in the CIB.  Will fail if the object already exists."},
     {"modify",      0, 0, 'M', "\tFind the object somewhere in the CIB's XML tree and update it.  Fails if the object does not exist unless -c is specified"},
+    {"patch",	    0, 0, 'P', "\tSupply an update in the form of an xml diff (See also: crm_diff)"},
     {"replace",     0, 0, 'R', "\tRecursivly replace an object in the CIB"},
     {"delete",      0, 0, 'D', "\tDelete the first object matching the supplied criteria, Eg. <op id=\"rsc1_op1\" name=\"monitor\"/>"},
-    {"-spacer-",    0, 0, '-', "\t\t\tThe tagname and all attributes must match in order for the element to be deleted"},
+    {"-spacer-",    0, 0, '-', "\n\t\t\tThe tagname and all attributes must match in order for the element to be deleted"},
     {"md5-sum",	    0, 0, '5', "\tCalculate a CIB digest"},    
-    {"patch",	    0, 0, 'P', "\tSupply an update in the form of an xml diff (as produced by crm_diff)"},
-    {"bump",        0, 0, 'B', "\tIncrease the CIB's epoch value by 1"},
-    {"sync",        0, 0, 'S', "\tForce a refresh of the CIB to all nodes\n"},
+    {"sync",        0, 0, 'S', "\t(Advanced) Force a refresh of the CIB to all nodes\n"},
     {"make-slave",  0, 0, 'r', NULL, 1},
     {"make-master", 0, 0, 'w', NULL, 1},
     {"is-master",   0, 0, 'm', NULL, 1},
 
-    {"-spacer-",    0, 0, '-', "Command Modifiers:"},
+    {"-spacer-",1, 0, '-', "\nAdditional options:"},
     {"force",	    0, 0, 'f'},
     {"timeout",	    1, 0, 't', "Time (in seconds) to wait before declaring the operation failed"},
     {"sync-call",   0, 0, 's', "Wait for call to complete before returning"},
@@ -107,15 +107,15 @@ static struct crm_option long_options[] = {
     {"no-children", 0, 0, 'n', "(Advanced) When querying an object, do not return include its children in the result\n"},
     {"no-bcast",    0, 0, 'b', NULL, 1},
 
-    {"-spacer-",    0, 0, '-', "Command Data:"},
+    {"-spacer-",    0, 0, '-', "Data:"},
     {"xml-text",    1, 0, 'X', "Retrieve XML from the supplied string"},
     {"xml-file",    1, 0, 'x', "Retrieve XML from the named file"},
     {"xml-pipe",    0, 0, 'p', "Retrieve XML from stdin\n"},
 
     {"xpath",       1, 0, 'A', "A valid XPath to use instead of -o"},
     {"obj_type",    1, 0, 'o', "Limit the scope of the operation to a specific section of the CIB."},
     {"-spacer-",    0, 0, '-', "\t\t\tValid values are: nodes, resources, constraints, crm_config, rsc_defaults, op_defaults, status"},
-    {"node",	    1, 0, 'N', "\t(Advanced) Send command to the specified host\n"},
+    {"node",	    1, 0, 'N', "(Advanced) Send command to the specified host\n"},
 
     {"-spacer-",    0, 0, '-', "\nExamples:\n"},
     {"-spacer-",    0, 0, '-', "cibadmin --query --local\t\t\t\tQuery the configuration from the local node\n"},
@@ -156,7 +156,7 @@ main(int argc, char **argv)
 
 	int option_index = 0;
 	crm_log_init("cibadmin", LOG_CRIT, FALSE, FALSE, argc, argv);
-	crm_set_options("V?$o:QDUCEX:t:Srwlsh:MmBfbRx:pP5N:A:unc", "command [modifiers] [data]", long_options,
+	crm_set_options("V?$o:QDUCEX:t:Srwlsh:MmBfbRx:pP5N:A:unc", "command [options] [data]", long_options,
 			"Provides direct access to the cluster configuration."
 			"\n\n Allows the configuration, or sections of it, to be queried, modified, replaced and deleted."
 			"\n\n Where necessary, XML data will be obtained using -X, -x, or -p options\n");

tools/crm_attribute.c

@@ -54,26 +54,26 @@ const char *attr_default = NULL;
 
 static struct crm_option long_options[] = {
     /* Top-level Options */
-    {"help",    0, 0, '?', "This text"},
-    {"version", 0, 0, '$', "Version information"  },
-    {"verbose", 0, 0, 'V', "Increase debug output\n"},
-    {"quiet",   0, 0, 'Q', "Print only the value on stdout\n"},
+    {"help",    0, 0, '?', "\tThis text"},
+    {"version", 0, 0, '$', "\tVersion information"  },
+    {"verbose", 0, 0, 'V', "\tIncrease debug output"},
+    {"quiet",   0, 0, 'Q', "\tPrint only the value on stdout\n"},
 
-    {"attr-name",   1, 0, 'n', "Name of the attribute/option to operate on\n"},
+    {"name",    1, 0, 'n', "Name of the attribute/option to operate on"},
 
     {"-spacer-",    0, 0, '-', "\nCommands:"},
-    {"query",       0, 0, 'G', "Query the current value of the attribute/option"},
+    {"query",       0, 0, 'G', "\tQuery the current value of the attribute/option"},
     {"update",      1, 0, 'v', "Update the value of the attribute/option"},
-    {"delete",      0, 0, 'D', "Delete the attribute/option"},
+    {"delete",      0, 0, 'D', "\tDelete the attribute/option"},
 
-    {"-spacer-",    0, 0, '-', "\nCommand Modifiers:"},
-    {"node",        1, 0, 'N', "Set the value for a node other than this one"},
+    {"-spacer-",    0, 0, '-', "\nAdditional Options:"},
+    {"node",        1, 0, 'N', "Set an attribute for the named node (instead of a cluster option).  See also: -l"},
     {"type",        1, 0, 't', "Which part of the configuration to update/delete/query the option in."},
-    {"-spacer-",    0, 0, '-', "\tValid values: crm_config, rsc_defaults, op_defaults"},
+    {"-spacer-",    0, 0, '-', "\t\t\tValid values: crm_config, rsc_defaults, op_defaults"},
     {"lifetime",    1, 0, 'l', "Lifetime of the node attribute."},
-    {"-spacer-",    0, 0, '-', "\tValid values: reboot, forever"},
+    {"-spacer-",    0, 0, '-', "\t\t\tValid values: reboot, forever"},
     {"set-name",    1, 0, 's', "(Advanced) The attribute set in which to place the value"},
-    {"attr-id",     1, 0, 'i', "(Advanced) The ID used to identify the attribute"},
+    {"id",	    1, 0, 'i', "\t(Advanced) The ID used to identify the attribute"},
     {"default",     1, 0, 'd', "(Advanced) The default value to display if none is found in the configuration"},
 
     {"inhibit-policy-engine", 0, 0, '!', NULL, 1},
@@ -84,7 +84,9 @@ static struct crm_option long_options[] = {
     {"get-value",   0, 0, 'G', NULL, 1},
     {"delete-attr", 0, 0, 'D', NULL, 1},
     {"attr-value",  1, 0, 'v', NULL, 1},
-    
+    {"attr-name",   1, 0, 'n', NULL, 1}, 
+    {"attr-id",     1, 0, 'i', NULL, 1}, 
+
     {0, 0, 0, 0}
 };
 
@@ -101,7 +103,7 @@ main(int argc, char **argv)
 	int option_index = 0;
 
 	crm_log_init(basename(argv[0]), LOG_ERR, FALSE, FALSE, argc, argv);
-	crm_set_options("V?$GDQN:U:u:s:n:v:l:t:i:!r:d:", "{command} -n {attribute} [-t|-l] [options]", long_options, "Manage node's attributes and cluster options."
+	crm_set_options("V?$GDQN:U:u:s:n:v:l:t:i:!r:d:", "command -n attribute [options]", long_options, "Manage node's attributes and cluster options."
 			"\n  Allows node attributes and cluster options to be queried, modified and deleted.");
 
 	if(argc < 2) {

tools/crm_mon.c

@@ -223,32 +223,34 @@ int cib_connect(gboolean full)
 
 static struct crm_option long_options[] = {
     /* Top-level Options */
-    {"help",           0, 0, '?', "This text"},
-    {"version",        0, 0, '$', "Version information"  },
-    {"verbose",        0, 0, 'V', "Increase debug output\n"},
-
-    {"interval",       1, 0, 'i', "Update frequency in seconds" },
-    {"one-shot",       0, 0, '1', "\tDisplay the cluster status once on the console and exit (doesnt use ncurses)"},
-    {"disable-ncurses",0, 0, 'N', "Disable the use of ncurses"},
-    {"daemonize",      0, 0, 'd', "\tRun in the background as a daemon"},
-    {"pid-file",       1, 0, 'p', "Daemon pid file location\n"},
+    {"help",           0, 0, '?', "\tThis text"},
+    {"version",        0, 0, '$', "\tVersion information"  },
+    {"verbose",        0, 0, 'V', "\tIncrease debug output"},
 
+    {"-spacer-",	1, 0, '-', "\nModes:"},
+    {"as-html",        1, 0, 'h', "Write cluster status to the named file"},
+    {"web-cgi",        0, 0, 'w', "\tWeb mode with output suitable for cgi"},
+    {"simple-status",  0, 0, 's', "Display the cluster status once as a simple one line output (suitable for nagios)"},
+    {"snmp-traps",     0, 0, 'S', "Send SNMP traps to this station"},
+    {"mail-to",        1, 0, 'T', "Send Mail alerts to this user.  See also --mail-from, --mail-host, --mail-prefix"},
+    
+    {"-spacer-",	1, 0, '-', "\nDisplay Options:"},
     {"group-by-node",  0, 0, 'n', "Group resources by node"     },
-    {"inactive",       0, 0, 'r', "\tDisplay inactive resources"  },
+    {"inactive",       0, 0, 'r', "Display inactive resources"  },
     {"failcounts",     0, 0, 'f', "Display resource fail counts"},
     {"operations",     0, 0, 'o', "Display resource operation history" },
     {"timing-details", 0, 0, 't', "Display resource operation history with timing details\n" },
 
-    {"snmp-traps",     0, 0, 'S', "Send SNMP traps to this station\n"},
+    {"-spacer-",	1, 0, '-', "\nAdditional Options:"},
+    {"interval",       1, 0, 'i', "\tUpdate frequency in seconds" },
+    {"one-shot",       0, 0, '1', "\tDisplay the cluster status once on the console and exit (doesnt use ncurses)"},
+    {"disable-ncurses",0, 0, 'N', "\tDisable the use of ncurses"},
+    {"daemonize",      0, 0, 'd', "\tRun in the background as a daemon"},
+    {"pid-file",       1, 0, 'p', "\t(Advanced) Daemon pid file location"},
+    {"mail-from",      1, 0, 'F', "\tMail alerts should come from the named user"},
+    {"mail-host",      1, 0, 'H', "\tMail alerts should be sent via the named host"},
+    {"mail-prefix",    1, 0, 'P', "Subjects for mail alerts should start with this string"},
 
-    {"as-html",        1, 0, 'h', "Write cluster status to the named file"},
-    {"web-cgi",        0, 0, 'w', "\tWeb mode with output suitable for cgi"},
-    {"simple-status",  0, 0, 's', "Display the cluster status once as a simple one line output (suitable for nagios)\n"},
-    
-    {"mail-to",        1, 0, 'T'},
-    {"mail-from",      1, 0, 'F'},
-    {"mail-host",      1, 0, 'H'},
-    {"mail-prefix",    1, 0, 'P'},
 
     {"xml-file",       1, 0, 'x', NULL, 1},
 
@@ -267,7 +269,7 @@ main(int argc, char **argv)
     pid_file = crm_strdup("/tmp/ClusterMon.pid");
     crm_log_init(basename(argv[0]), LOG_CRIT, FALSE, FALSE, 0, NULL);
 
-    crm_set_options("V?$i:nrh:dp:s1wx:oftNS:T:F:H:P:", "[-?|-v|-1|-N|-d -p] [-h|-w|-s] [-S] [-T -F -H -P] [-i] [-n] [-r] [-f] [-o|-t]", long_options,
+    crm_set_options("V?$i:nrh:dp:s1wx:oftNS:T:F:H:P:", "mode [options]", long_options,
 		    "Provides a summary of cluster's current state.\n  Outputs varying levels of detail in a number of different formats.\n");
 
     if (strcmp(crm_system_name, "crm_mon.cgi")==0) {