Merge branch '208-ldas-analysis-ready-help' into 'ldas-tools-suite-2.9.x'

Added displaying of help text for ldas_analysis_ready for -h/--help option (closes #208)

See merge request !214

(cherry picked from commit c6aee520)

f8392a28 Added displaying of help text for ldas_analysis_ready for -h/--help option (closes #208)

frameutils/ChangeLog.md

+# Release NEXT -
+    - Added displaying of help text for ldas_analysis_ready for -h/--help option (closes #208)
+'
 # Release 3.0.3 - December 14, 2023
     - Remove leading and trailing whitespaces from lines read from configuration file (closes #197)
 

frameutils/src/ldas_analysis_ready.cc

@@ -85,6 +85,8 @@ public:
 
     bool SingleEntryPerLine( ) const;
 
+    void Usage( int ExitStatus ) const;
+
 private:
     options_type                          options_visible;
     char* const                           program_name;
@@ -96,7 +98,7 @@ private:
 };
 
 CommandLine::CommandLine( int ArgC, char** ArgV )
-    : program_name( ArgV[ 0 ] ), options_visible( "Allowed options" )
+    : options_visible( "Allowed options" ), program_name( ArgV[ 0 ] )
 {
     //-------------------------------------------------------------------
     // Options visible to help
@@ -123,8 +125,8 @@ CommandLine::CommandLine( int ArgC, char** ArgV )
           boost::program_options::value< std::string >( &ifo )->default_value(
               "H1" ),
           "analysis ready channel name" ) //
-      ( "single-entry-per-line",
-        "print each entry on a separate line" ) //
+        ( "single-entry-per-line",
+          "print each entry on a separate line" ) //
         ;
     //-------------------------------------------------------------------
     // Parse the options
@@ -135,6 +137,11 @@ CommandLine::CommandLine( int ArgC, char** ArgV )
             .run( ),
         options_variable_map );
     boost::program_options::notify( options_variable_map );
+
+    if ( options_variable_map.count( "help" ) )
+    {
+        Usage( 0 );
+    }
 }
 
 inline int
@@ -173,6 +180,13 @@ CommandLine::SingleEntryPerLine( ) const
     return options_variable_map.count( "single-entry-per-line" );
 }
 
+inline void
+CommandLine::Usage( int ExitStatus ) const
+{
+    std::cerr << options_visible << std::endl;
+    exit( ExitStatus );
+}
+
 inline void
 CommandLine::operator( )( )
 {
@@ -369,7 +383,6 @@ find_analysis_ready_intervals(
     FrameCPP::FrTOC const* toc =
         dynamic_cast< FrameCPP::FrTOC const* >( frame_stream.GetTOC( ) );
     std::ostringstream channel_name;
-    INT_4U             gps_start_time_of_frame;
 
     channel_name << Options.IFO( ) << ":"
                  << Options.AnalysisReadyChannelName( );
@@ -411,7 +424,6 @@ find_analysis_ready_intervals(
 int
 main( int ArgC, char** ArgV )
 {
-    static const char*                       caller = "main";
     MemChecker::Trigger                      gc_trigger( true );
     static FrameAPI::interval_container_type analysis_ready;