From: Joel Holdsworth <redacted>
Date: Sat, 13 Oct 2012 00:15:47 +0000 (+0100)
Subject: Added --help option
X-Git-Tag: pulseview-0.1.0~260
X-Git-Url: https://sigrok.org/gitaction?a=commitdiff_plain;h=d4384c6d5c7cb6dc16979c650cd21aa29f0aedb5;p=pulseview.git

Added --help option
---

diff --git a/CMakeLists.txt b/CMakeLists.txt
index d1f122c4..0d3464b7 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -59,6 +59,7 @@ find_package(Boost 1.46 COMPONENTS unit_test_framework REQUIRED)
 #-------------------------------------------------------------------------------
 
 set(PV_TITLE PulseView)
+set(PV_DESCRIPTION "A GUI for sigrok")
 
 set(PV_VERSION_MAJOR 0)
 set(PV_VERSION_MINOR 1)
diff --git a/config.h.in b/config.h.in
index 6caa2303..8f49bbf7 100644
--- a/config.h.in
+++ b/config.h.in
@@ -22,6 +22,8 @@
 
 /* Application Details */
 #define PV_TITLE "@PV_TITLE@"
+#define PV_DESCRIPTION "@PV_DESCRIPTION@"
+#define PV_BIN_NAME "@PROJECT_NAME@"
 
 /* Pulseview version information */
 #define PV_VERSION_MAJOR @PV_VERSION_MAJOR@
diff --git a/main.cpp b/main.cpp
index a94f64c6..b7ba5d89 100644
--- a/main.cpp
+++ b/main.cpp
@@ -33,6 +33,18 @@ extern "C" {
 
 #include "config.h"
 
+void usage()
+{
+	fprintf(stderr,
+		"Usage:\n"
+		"  %s — %s\n"
+		"\n"
+		"Help Options:\n"
+		"  -V, --version                   Show release version\n"
+		"  -h, -?, --help                  Show help option\n"
+		"\n", PV_BIN_NAME, PV_DESCRIPTION);
+}
+
 int main(int argc, char *argv[])
 {
 	QApplication a(argc, argv);
@@ -46,10 +58,12 @@ int main(int argc, char *argv[])
 	while (1) {
 		static const struct option long_options[] = {
 			{"version", no_argument, 0,  'V'},
+			{"help", no_argument, 0,  'h'},
 			{0, 0, 0, 0}
 		};
 
-		const char c = getopt_long(argc, argv, "V", long_options, NULL);
+		const char c = getopt_long(argc, argv,
+			"Vh?", long_options, NULL);
 		if (c == -1)
 			break;
 
@@ -58,6 +72,11 @@ int main(int argc, char *argv[])
 			// Print version info
 			fprintf(stderr, "%s %s\n", PV_TITLE, PV_VERSION_STRING);
 			return 0;
+
+		case 'h':
+		case '?':
+			usage();
+			return 0;
 		}
 	}