From: Philippe Proulx <eeppeliteloop@gmail.com>
Date: Tue, 17 Nov 2015 06:37:20 +0000 (-0500)
Subject: lttng.c: show man page with --help and remove usage
X-Git-Tag: v2.8.0-rc1~28
X-Git-Url: https://git.lttng.org./?a=commitdiff_plain;h=f67353ba14d7c2c860b4ed59247a38da77a481ce;p=lttng-tools.git

lttng.c: show man page with --help and remove usage

Signed-off-by: Philippe Proulx <eeppeliteloop@gmail.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
---

diff --git a/src/bin/lttng/lttng.c b/src/bin/lttng/lttng.c
index 7ab1125e3..aa13bc45d 100644
--- a/src/bin/lttng/lttng.c
+++ b/src/bin/lttng/lttng.c
@@ -29,6 +29,7 @@
 #include <lttng/lttng.h>
 #include <common/error.h>
 #include <common/compat/getenv.h>
+#include <common/utils.h>
 
 #include "command.h"
 
@@ -88,55 +89,6 @@ static struct cmd_struct commands[] =  {
 	{ NULL, NULL}	/* Array closure */
 };
 
-static void usage(FILE *ofp)
-{
-	fprintf(ofp, "LTTng Trace Control " VERSION " - " VERSION_NAME "%s\n\n",
-		GIT_VERSION[0] == '\0' ? "" : " - " GIT_VERSION);
-	fprintf(ofp, "usage: lttng [OPTIONS] <COMMAND> [<ARGS>]\n");
-	fprintf(ofp, "\n");
-	fprintf(ofp, "Options:\n");
-	fprintf(ofp, "  -V, --version              Show version\n");
-	fprintf(ofp, "  -h, --help                 Show this help\n");
-	fprintf(ofp, "      --list-options         Simple listing of lttng options\n");
-	fprintf(ofp, "      --list-commands        Simple listing of lttng commands\n");
-	fprintf(ofp, "  -v, --verbose              Increase verbosity\n");
-	fprintf(ofp, "  -q, --quiet                Quiet mode\n");
-	fprintf(ofp, "  -m, --mi TYPE              Machine Interface mode.\n");
-	fprintf(ofp, "                                 Type: xml\n");
-	fprintf(ofp, "  -g, --group NAME           Unix tracing group name. (default: tracing)\n");
-	fprintf(ofp, "  -n, --no-sessiond          Don't spawn a session daemon\n");
-	fprintf(ofp, "      --sessiond-path PATH   Session daemon full path\n");
-	fprintf(ofp, "      --relayd-path PATH     Relayd daemon full path\n");
-	fprintf(ofp, "\n");
-	fprintf(ofp, "Commands:\n");
-	fprintf(ofp, "    add-context       Add context to event and/or channel\n");
-	fprintf(ofp, "    calibrate         Quantify LTTng overhead\n");
-	fprintf(ofp, "    create            Create tracing session\n");
-	fprintf(ofp, "    destroy           Tear down tracing session\n");
-	fprintf(ofp, "    enable-channel    Enable tracing channel\n");
-	fprintf(ofp, "    enable-event      Enable tracing event\n");
-	fprintf(ofp, "    disable-channel   Disable tracing channel\n");
-	fprintf(ofp, "    disable-event     Disable tracing event\n");
-	fprintf(ofp, "    list              List possible tracing options\n");
-	fprintf(ofp, "    set-session       Set current session name\n");
-	fprintf(ofp, "    snapshot          Snapshot buffers of current session name\n");
-	fprintf(ofp, "    start             Start tracing\n");
-	fprintf(ofp, "    status            Show current session's details\n");
-	fprintf(ofp, "    stop              Stop tracing\n");
-	fprintf(ofp, "    version           Show version information\n");
-	fprintf(ofp, "    view              Start trace viewer\n");
-	fprintf(ofp, "    save              Save session configuration\n");
-	fprintf(ofp, "    load              Load session configuration\n");
-	fprintf(ofp, "    track             Track specific system resources\n");
-	fprintf(ofp, "    untrack           Untrack specific system resources\n");
-	fprintf(ofp, "    metadata          Regenerate the metadata of a session\n");
-	fprintf(ofp, "\n");
-	fprintf(ofp, "Each command also has its own -h, --help option.\n");
-	fprintf(ofp, "\n");
-	fprintf(ofp, "Please see the lttng(1) man page for full documentation.\n");
-	fprintf(ofp, "See http://lttng.org for updates, bug reports and news.\n");
-}
-
 static void version(FILE *ofp)
 {
 	fprintf(ofp, "%s (LTTng Trace Control) " VERSION" - " VERSION_NAME "%s\n",
@@ -298,7 +250,6 @@ static int parse_args(int argc, char **argv)
 	}
 
 	if (argc < 2) {
-		usage(stderr);
 		clean_exit(EXIT_FAILURE);
 	}
 
@@ -309,8 +260,12 @@ static int parse_args(int argc, char **argv)
 			ret = 0;
 			goto end;
 		case 'h':
-			usage(stdout);
-			ret = 0;
+			ret = utils_show_man_page(1, "lttng");
+
+			if (ret) {
+				ERR("Cannot view man page lttng(1)");
+				perror("exec");
+			}
 			goto end;
 		case 'v':
 			/* There is only 3 possible level of verbosity. (-vvv) */
@@ -357,7 +312,6 @@ static int parse_args(int argc, char **argv)
 			ret = 0;
 			goto end;
 		default:
-			usage(stderr);
 			ret = 1;
 			goto error;
 		}
@@ -368,9 +322,8 @@ static int parse_args(int argc, char **argv)
 		lttng_opt_verbose = 0;
 	}
 
-	/* No leftovers, print usage and quit */
+	/* No leftovers, quit */
 	if ((argc - optind) == 0) {
-		usage(stderr);
 		ret = 1;
 		goto error;
 	}
@@ -405,7 +358,6 @@ static int parse_args(int argc, char **argv)
 		ERR("Unsupported command");
 		break;
 	case -1:
-		usage(stderr);
 		ret = 1;
 		break;
 	case 0: