fdsdump: add -h command line option

Author: sedmicha

src/tools/fdsdump/src/main.cpp

@@ -30,6 +30,10 @@ main(int argc, char *argv[])
     try {
         Options options {argc, argv};
 
+        if (options.get_help_flag()) {
+            Options::print_usage();
+            return EXIT_SUCCESS;
+        }
 
         switch (options.get_mode()) {
         case Options::Mode::list:
@@ -44,6 +48,12 @@ main(int argc, char *argv[])
         default:
             throw std::runtime_error("Invalid mode");
         }
+
+    } catch (const OptionsException &ex) {
+        std::cerr << "ERROR: " << ex.what() << std::endl;
+        Options::print_usage();
+        return EXIT_FAILURE;
+
     } catch (const std::exception &ex) {
         std::cerr << "ERROR: " << ex.what() << std::endl;
         return EXIT_FAILURE;

src/tools/fdsdump/src/options.cpp

@@ -19,6 +19,23 @@
 
 namespace fdsdump {
 
+void Options::print_usage()
+{
+    std::cerr << "Usage: fdsdump [OPTIONS]\n";
+    std::cerr << "\n";
+    std::cerr << "Options:\n";
+    std::cerr << "  -h, --help                       Show this help message\n";
+    std::cerr << "  -r, --input FILE                 File or glob pattern of files to read\n";
+    std::cerr << "  -f, --filter EXPR                Select only records matching filter expression (default = all records)\n";
+    std::cerr << "  -o, --output FMT                 Output format - TABLE, JSON, JSON-RAW\n";
+    std::cerr << "  -O, --order FIELDS               Record fields and order direction to order by\n";
+    std::cerr << "  -c, --limit NUM                  Max number of output records (default = infinite)\n";
+    std::cerr << "  -A, --aggregation-keys FIELDS    Fields making up the aggregation key (default = none)\n";
+    std::cerr << "  -S, --aggregation-values FIELDS  Fields that will be aggregated (default = flows,packets,bytes)\n";
+    std::cerr << "  -I, --stats-mode                 Run in statistics mode\n";
+    std::cerr << "  --no-biflow-autoignore           Turn off smart ignoring of empty biflow records\n";
+}
+
 Options::Options()
 {
     reset();
@@ -33,6 +50,7 @@ Options::Options(int argc, char *argv[])
 
 void Options::reset()
 {
+    m_help_flag = false;
     m_mode = Mode::undefined;
 
     m_input_files.clear();
@@ -60,6 +78,7 @@ void Options::reset()
 void Options::parse(int argc, char *argv[])
 {
 	ArgParser parser;
+	parser.add('h', "help", false);
 	parser.add('r', "input", true);
 	parser.add('F', "filter", true);
 	parser.add('o', "output", true);
@@ -79,6 +98,10 @@ void Options::parse(int argc, char *argv[])
 		throw OptionsException("Unknown argument " + unknown.arg);
 	}
 
+	if (args.has('h')) {
+		m_help_flag = true;
+	}
+
 	if (args.has('r')) {
 		for (const auto &arg : args.get_all('r')) {
 			m_input_files.add_files(arg);

src/tools/fdsdump/src/options.hpp

@@ -43,6 +43,11 @@ class Options {
         stats,
     };
 
+    /**
+     * @brief Print the usage message
+     */
+    static void print_usage();
+
     /**
      * @brief Create options with default values.
      */
@@ -60,6 +65,8 @@ class Options {
      */
     void reset();
 
+    bool get_help_flag() const { return m_help_flag; };
+
     const Mode &get_mode() const { return m_mode; };
 
     /** @brief Get list of files to process.             */
@@ -86,6 +93,8 @@ class Options {
 private:
     Mode m_mode;
 
+    bool m_help_flag;
+
     FileList    m_input_files;
     std::string m_input_filter;