imporve netdatacli help usage readability (netdata#18403)

webfutureiorepo · Aug 24, 2024 · 178fbc6 · 178fbc6
1 parent 313f18b
commit 178fbc6
Showing 1 changed file with 14 additions and 14 deletions.
diff --git a/src/daemon/commands.c b/src/daemon/commands.c
@@ -108,31 +108,31 @@ static cmd_status_t cmd_help_execute(char *args, char **message)
 
     *message = mallocz(MAX_COMMAND_LENGTH);
     strncpyz(*message,
-             "\nThe commands are (arguments are in brackets):\n"
+             "\nThe commands are:\n\n"
              "help\n"
-             "    Show this help menu.\n"
+             "    Show this help menu.\n\n"
              "reload-health\n"
-             "    Reload health configuration.\n"
+             "    Reload health configuration.\n\n"
              "reload-labels\n"
-             "    Reload all labels.\n"
+             "    Reload all labels.\n\n"
              "save-database\n"
-             "    Save internal DB to disk for memory mode save.\n"
+             "    Save internal DB to disk for memory mode save.\n\n"
              "reopen-logs\n"
-             "    Close and reopen log files.\n"
+             "    Close and reopen log files.\n\n"
              "shutdown-agent\n"
-             "    Cleanup and exit the netdata agent.\n"
+             "    Cleanup and exit the netdata agent.\n\n"
              "fatal-agent\n"
-             "    Log the state and halt the netdata agent.\n"
+             "    Log the state and halt the netdata agent.\n\n"
              "reload-claiming-state\n"
-             "    Reload agent claiming state from disk.\n"
+             "    Reload agent claiming state from disk.\n\n"
              "ping\n"
-             "    Return with 'pong' if agent is alive.\n"
+             "    Return with 'pong' if agent is alive.\n\n"
              "aclk-state [json]\n"
-             "    Returns current state of ACLK and Cloud connection. (optionally in json).\n"
+             "    Returns current state of ACLK and Cloud connection. (optionally in json).\n\n"
              "dumpconfig\n"
-             "    Returns the current netdata.conf on stdout.\n"
-             "remove-stale-node node_id|machine_guid|hostname|ALL_NODES\n"
-             "    Unregisters and removes a node from the cloud.\n"
+             "    Returns the current netdata.conf on stdout.\n\n"
+             "remove-stale-node <node_id | machine_guid | hostname | ALL_NODES>\n"
+             "    Unregisters and removes a node from the cloud.\n\n"
              "version\n"
              "    Returns the netdata version.\n",
              MAX_COMMAND_LENGTH - 1);