X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=src%2Fbin%2Flttng%2Flttng.c;h=bf2128ca35896dbbc998ecadf125e7eb4774ed6d;hb=f3b3a67b8a5a7b2e4f7637d261a9e356d233ae23;hp=bcfbf88e65aed6c701e5d2e2a458a1c2e9918dd0;hpb=960afba4f737174cd305af2019d9c2c781ec6c4e;p=lttng-tools.git

diff --git a/src/bin/lttng/lttng.c b/src/bin/lttng/lttng.c
index bcfbf88e6..bf2128ca3 100644
--- a/src/bin/lttng/lttng.c
+++ b/src/bin/lttng/lttng.c
@@ -33,6 +33,14 @@
 
 #include "command.h"
 
+static const char *help_msg =
+#ifdef LTTNG_EMBED_HELP
+#include <lttng.1.h>
+#else
+NULL
+#endif
+;
+
 /* Variables */
 static char *progname;
 int opt_no_sessiond;
@@ -65,28 +73,28 @@ static struct option long_options[] = {
 
 /* First level command */
 static struct cmd_struct commands[] =  {
-	{ "list", cmd_list},
-	{ "status", cmd_status},
+	{ "add-context", cmd_add_context},
 	{ "create", cmd_create},
 	{ "destroy", cmd_destroy},
-	{ "start", cmd_start},
-	{ "stop", cmd_stop},
-	{ "enable-event", cmd_enable_events},
+	{ "disable-channel", cmd_disable_channels},
 	{ "disable-event", cmd_disable_events},
 	{ "enable-channel", cmd_enable_channels},
-	{ "disable-channel", cmd_disable_channels},
-	{ "add-context", cmd_add_context},
+	{ "enable-event", cmd_enable_events},
+	{ "help", NULL},
+	{ "list", cmd_list},
+	{ "load", cmd_load},
+	{ "metadata", cmd_metadata},
+	{ "regenerate", cmd_regenerate},
+	{ "save", cmd_save},
 	{ "set-session", cmd_set_session},
-	{ "version", cmd_version},
-	{ "calibrate", cmd_calibrate},
-	{ "view", cmd_view},
 	{ "snapshot", cmd_snapshot},
-	{ "save", cmd_save},
-	{ "load", cmd_load},
+	{ "start", cmd_start},
+	{ "status", cmd_status},
+	{ "stop", cmd_stop},
 	{ "track", cmd_track},
 	{ "untrack", cmd_untrack},
-	{ "metadata", cmd_metadata},
-	{ "help", NULL},
+	{ "version", cmd_version},
+	{ "view", cmd_view},
 	{ NULL, NULL}	/* Array closure */
 };
 
@@ -241,6 +249,54 @@ end:
 	return ret;
 }
 
+static void show_basic_help(void)
+{
+	puts("Usage: lttng [--group=GROUP] [--mi=TYPE] [--no-sessiond | --sessiond-path=PATH]");
+	puts("             [--quiet | -v | -vv | -vvv] COMMAND [COMMAND OPTIONS]");
+	puts("");
+	puts("Available commands:");
+	puts("");
+	puts("Tracing sessions:");
+	puts("  create            " CONFIG_CMD_DESCR_CREATE);
+	puts("  destroy           " CONFIG_CMD_DESCR_DESTROY);
+	puts("  load              " CONFIG_CMD_DESCR_LOAD);
+	puts("  regenerate        " CONFIG_CMD_DESCR_REGENERATE);
+	puts("  save              " CONFIG_CMD_DESCR_SAVE);
+	puts("  set-session       " CONFIG_CMD_DESCR_SET_SESSION);
+	puts("");
+	puts("Channels:");
+	puts("  add-context       " CONFIG_CMD_DESCR_ADD_CONTEXT);
+	puts("  disable-channel   " CONFIG_CMD_DESCR_DISABLE_CHANNEL);
+	puts("  enable-channel    " CONFIG_CMD_DESCR_ENABLE_CHANNEL);
+	puts("");
+	puts("Event rules:");
+	puts("  disable-event     " CONFIG_CMD_DESCR_DISABLE_EVENT);
+	puts("  enable-event      " CONFIG_CMD_DESCR_ENABLE_EVENT);
+	puts("");
+	puts("Status:");
+	puts("  list              " CONFIG_CMD_DESCR_LIST);
+	puts("  status            " CONFIG_CMD_DESCR_STATUS);
+	puts("");
+	puts("Control:");
+	puts("  snapshot          " CONFIG_CMD_DESCR_SNAPSHOT);
+	puts("  start             " CONFIG_CMD_DESCR_START);
+	puts("  stop              " CONFIG_CMD_DESCR_STOP);
+	puts("");
+	puts("Resource tracking:");
+	puts("  track             " CONFIG_CMD_DESCR_TRACK);
+	puts("  untrack           " CONFIG_CMD_DESCR_UNTRACK);
+	puts("");
+	puts("Miscellaneous:");
+	puts("  help              " CONFIG_CMD_DESCR_HELP);
+	puts("  version           " CONFIG_CMD_DESCR_VERSION);
+	puts("  view              " CONFIG_CMD_DESCR_VIEW);
+	puts("");
+	puts("Run `lttng help COMMAND` or `lttng COMMAND --help` to get help with");
+	puts("command COMMAND.");
+	puts("");
+	puts("See `man lttng` for more help with the lttng command.");
+}
+
 /*
  * Parse command line arguments.
  *
@@ -249,7 +305,6 @@ end:
 static int parse_args(int argc, char **argv)
 {
 	int opt, ret;
-	char *user;
 
 	if (lttng_is_setuid_setgid()) {
 		ERR("'%s' is not allowed to be executed as a setuid/setgid binary for security reasons. Aborting.", argv[0]);
@@ -257,6 +312,7 @@ static int parse_args(int argc, char **argv)
 	}
 
 	if (argc < 2) {
+		show_basic_help();
 		clean_exit(EXIT_FAILURE);
 	}
 
@@ -267,10 +323,9 @@ static int parse_args(int argc, char **argv)
 			ret = 0;
 			goto end;
 		case 'h':
-			ret = utils_show_man_page(1, "lttng");
-
+			ret = utils_show_help(1, "lttng", help_msg);
 			if (ret) {
-				ERR("Cannot view man page lttng(1)");
+				ERR("Cannot show --help for `lttng`");
 				perror("exec");
 			}
 			goto end;
@@ -297,6 +352,7 @@ static int parse_args(int argc, char **argv)
 			opt_no_sessiond = 1;
 			break;
 		case OPT_SESSION_PATH:
+			free(opt_sessiond_path);
 			opt_sessiond_path = strdup(optarg);
 			if (!opt_sessiond_path) {
 				ret = -1;
@@ -304,6 +360,7 @@ static int parse_args(int argc, char **argv)
 			}
 			break;
 		case OPT_RELAYD_PATH:
+			free(opt_relayd_path);
 			opt_relayd_path = strdup(optarg);
 			if (!opt_relayd_path) {
 				ret = -1;
@@ -335,14 +392,6 @@ static int parse_args(int argc, char **argv)
 		goto error;
 	}
 
-	/* For Mathieu Desnoyers a.k.a. Dr. Tracing */
-	user = getenv("USER");
-	if (user != NULL && ((strncmp(progname, "drtrace", 7) == 0 ||
-					strncmp("compudj", user, 7) == 0))) {
-		MSG("%c[%d;%dmWelcome back Dr Tracing!%c[%dm\n", 27,1,33,27,0);
-	}
-	/* Thanks Mathieu */
-
 	/*
 	 * Handle leftovers which is a first level command with the trailing
 	 * options.