Changeset 1855

Timestamp:

22/09/2007 00:52:08 (16 months ago)

Author:

chris

Message:

Add "-h" and "/?" options to display usage in Daemon.

Extend usage info with service commands in BackupDaemon?.

Disable useless -D, -V and -k options on Windows.

Location:

box/chris/general

Files:

• bin/bbackupd/BackupDaemon.cpp (modified) (2 diffs)
• bin/bbackupd/BackupDaemon.h (modified) (1 diff)
• bin/bbstored/BackupStoreDaemon.cpp (modified) (1 diff)
• bin/bbstored/BackupStoreDaemon.h (modified) (1 diff)
• lib/server/Daemon.cpp (modified) (10 diffs)
• lib/server/Daemon.h (modified) (2 diffs)

box/chris/general/bin/bbackupd/BackupDaemon.cpp

@@ -38 +38 @@
         #include <process.h>
 #endif
+
+#include <iostream>
 
 #include "Configuration.h"
@@ -210 +212 @@
 //
 // --------------------------------------------------------------------------
-const char *BackupDaemon::DaemonBanner() const
-{
-#ifndef NDEBUG
-        // Don't display banner in debug builds
-        return 0;
-#else
+std::string BackupDaemon::DaemonBanner() const
+{
         return BANNER_TEXT("Backup Client");
+}
+
+void BackupDaemon::Usage()
+{
+        this->Daemon::Usage();
+
+#ifdef WIN32
+        std::cout <<
+        "  -s         Run as a Windows Service, for internal use only\n"
+        "  -i         Install Windows Service (you may want to specify a config file)\n"
+        "  -r         Remove Windows Service\n"
+        "  -S <name>  Service name for -i and -r options\n";
 #endif
 }

box/chris/general/bin/bbackupd/BackupDaemon.h

@@ -70 +70 @@
         void Run();
         virtual const char *DaemonName() const;
-        virtual const char *DaemonBanner() const;
+        virtual std::string DaemonBanner() const;
+        virtual void Usage();
         const ConfigurationVerify *GetConfigVerify() const;
 

box/chris/general/bin/bbstored/BackupStoreDaemon.cpp

@@ -94 +94 @@
 //
 // --------------------------------------------------------------------------
-const char *BackupStoreDaemon::DaemonBanner() const
-{
-#ifndef NDEBUG
-        // Don't display banner in debug builds
-        return 0;
-#else
+std::string BackupStoreDaemon::DaemonBanner() const
+{
         return BANNER_TEXT("Backup Store Server");
-#endif
 }
 

box/chris/general/bin/bbstored/BackupStoreDaemon.h

@@ -57 +57 @@
         
         virtual const char *DaemonName() const;
-        virtual const char *DaemonBanner() const;
+        virtual std::string DaemonBanner() const;
 
         const ConfigurationVerify *GetConfigVerify() const;

box/chris/general/lib/server/Daemon.cpp

@@ -23 +23 @@
         #include <ws2tcpip.h>
 #endif
+
+#include <iostream>
 
 #include "Daemon.h"
@@ -52 +54 @@
           mRunInForeground(false),
           mKeepConsoleOpenAfterFork(false),
-          mHaveConfigFile(false)
+          mHaveConfigFile(false),
+          mAppName(DaemonName())
 {
         if(spDaemon != NULL)
@@ -100 +103 @@
 std::string Daemon::GetOptionString()
 {
-        return "c:DFqvVt:Tk";
+        return "c:"
+        #ifndef WIN32
+                "DFk"
+        #endif
+                "hqvVt:T";
+}
+
+void Daemon::Usage()
+{
+        std::cout << 
+        DaemonBanner() << "\n"
+        "\n"
+        "Usage: " << mAppName << " [options] [config file]\n" <<
+        "\n"
+        "Options:\n"
+        "  -c <file>  Use the specified configuration file. If -c is omitted, the last\n"
+        "             argument is the configuration file\n"
+#ifndef WIN32
+        "  -D         Debugging mode, do not fork, one process only, one client only\n"
+        "  -F         Do not fork into background, but fork to serve multiple clients\n"
+        "  -k         Keep console open after fork, keep writing log messages to it\n"
+#endif
+        "  -q         Run more quietly, reduce verbosity level by one, can repeat\n"
+        "  -v         Run more verbosely, increase verbosity level by one, can repeat\n"
+        "  -V         Run at maximum verbosity\n"
+        "  -t <tag>   Tag console output with specified marker\n"
+        "  -T         Timestamp console output\n";
 }
 
@@ -125 +154 @@
                 break;
 
+#ifndef WIN32
                 case 'D':
                 {
@@ -134 +164 @@
                 {
                         mRunInForeground = true;
+                }
+                break;
+
+                case 'k':
+                {
+                        mKeepConsoleOpenAfterFork = true;
+                }
+                break;
+#endif
+
+                case 'h':
+                {
+                        Usage();
+                        return 2;
                 }
                 break;
@@ -181 +225 @@
                 break;
 
-                case 'k':
-                {
-                        mKeepConsoleOpenAfterFork = true;
-                }
-                break;
-
                 case '?':
                 {
@@ -220 +258 @@
         // Find filename of config file
         mConfigFileName = DefaultConfigFile;
+        mAppName = argv[0];
 
         #ifdef NDEBUG
@@ -226 +265 @@
         mLogLevel = Log::INFO; // need an int to do math with
         #endif
+
+        if (argc == 2 && strcmp(argv[1], "/?") == 0)
+        {
+                Usage();
+                return 2;
+        }
 
         signed int c;
@@ -284 +329 @@
         // Banner (optional)
         {
-                const char *banner = DaemonBanner();
-                if(banner != 0)
-                {
-                        BOX_NOTICE(banner);
-                }
+                #ifndef NDEBUG
+                BOX_NOTICE(DaemonBanner());
+                #endif
         }
 
@@ -672 +715 @@
 //
 // --------------------------------------------------------------------------
-const char *Daemon::DaemonBanner() const
-{
-        return 0;
+std::string Daemon::DaemonBanner() const
+{
+        return "Generic daemon using the Box Application Framework";
 }
 

box/chris/general/lib/server/Daemon.h

@@ -51 +51 @@
 
         virtual const char *DaemonName() const;
-        virtual const char *DaemonBanner() const;
+        virtual std::string DaemonBanner() const;
         virtual const ConfigurationVerify *GetConfigVerify() const;
+        virtual void Usage();
         
         bool StopRun() {return mReloadConfigWanted | mTerminateWanted;}
@@ -88 +89 @@
         int mLogLevel; // need an int to do math with
         static Daemon *spDaemon;
+        std::string mAppName;
 };