fixed some minor documentation typos
[senf.git] / senf / Utils / Daemon / Daemon.hh
index 9c824fe..d55a010 100644 (file)
@@ -27,7 +27,6 @@
 #define HH_SENF_Utils_Daemon_Daemon_ 1
 
 // Custom includes
-#include <boost/utility.hpp>
 #include <senf/Utils/Logger/SenfLog.hh>
 
 //#include "Daemon.mpp"
@@ -46,12 +45,12 @@ namespace senf {
             for a later fork().
         \li <i>Automatic pid file management.</i> The daemon will not be started, if a valid pid
             file is found. Stale pid files are automatically removed.
-        \li <i>Console log management.</i> It is possible, to redirect standard output and error to
-            one or two log files. Messages pertaining to application initialization will be written
-            to both the console and the log file whereas later messages will be directed to the log
+        \li <i>Console %log management.</i> It is possible, to redirect standard output and error to
+            one or two %log files. Messages pertaining to application initialization will be written
+            to both the %console and the %log file whereas later messages will be directed to the log
             file only.
         \li <i>Optional foreground execution.</i> The daemon may be started in the foreground for
-            debugging purposes. In this case, the console log file(s) is/are automatically
+            debugging purposes. In this case, the %console %log file(s) is/are automatically
             suppressed.
 
         Starting the daemon process proceeds along the following steps:
@@ -59,7 +58,7 @@ namespace senf {
             normally happens from the \c main() function generated by \ref SENF_DAEMON_MAIN().
         \li configure() is called. This (virtual) member configures the daemon manager by calling
             the Daemon class parameter members.
-        \li The log files are opened, \c fork() is called and the pid file is checked and
+        \li The %log files are opened, \c fork() is called and the pid file is checked and
             created. The parent (foreground) process keeps running overseeing the daemon process.
         \li main() is called. This virtual member may optionally be overridden in the derived
             class. Here we assume, main() is not overridden so the default implementation is used.
@@ -81,11 +80,11 @@ namespace senf {
         <tr><td><tt>--no-daemon</tt></td><td>Run in foreground</td></tr>
 
         <tr><td><tt>--console-log=</tt><i>stdout</i>[<tt>,</tt><i>stderr</i>]</td><td>Set the
-        console log file(s). If only \a stdout is specified (with no comma), the same log file
+        %console %log file(s). If only \a stdout is specified (with no comma), the same %log file
         configuration will be applied to the standard output and error stream. Otherwise each stream
-        is assigned it's own log file. If either log file name is empty, the command will not change
-        the log file of that stream, the default log file will be used. If the log file name is set
-        to 'none', the log file will be disabled.</td></tr>
+        is assigned it's own %log file. If either %log file name is empty, the command will not change
+        the %log file of that stream, the default %log file will be used. If the %log file name is set
+        to 'none', the %log file will be disabled.</td></tr>
 
         <tr><td><tt>--pid-file=</tt><i>pidfile</i></td><td>Set pid file path</td></tr>
 
@@ -94,9 +93,9 @@ namespace senf {
         The default configure() implementation will use whatever parameters have been set beforehand
         as default values. These default values should be set in a derived class configure()
         implementation. After setting the default values, the configure() implementation may choose
-        to call this default configure() implementation to scan for command line parmeters.  The
+        to call this default configure() implementation to scan for command line parameters.  The
         default configure() implementation does \e not completely parse the command line
-        arguments. It just checks, if any of above arguments are present and precesses them. Other
+        arguments. It just checks, if any of above arguments are present and processes them. Other
         arguments are completely ignored. The command line parameters should be completely processed
         within init().
 
@@ -130,13 +129,13 @@ namespace senf {
         bool daemon();                  ///< \c true, if running as daemon
 
         void consoleLog(std::string const &, StdStream which = Both);
-                                        ///< Configure console log file
-                                        /**< May be called multiple times to set the log file
-                                             for stdout and stderr seperately. Any standard stream
-                                             not assigned to a log file will be redirected to
+                                        ///< Configure %console %log file
+                                        /**< May be called multiple times to set the %log file
+                                             for stdout and stderr separately. Any standard stream
+                                             not assigned to a %log file will be redirected to
                                              <tt>/dev/null</tt>.
 
-                                             When running in the foreground, the log files will be
+                                             When running in the foreground, the %log files will be
                                              ignored. */
 
         void pidFile(std::string const &); ///< Configure pid file
@@ -162,7 +161,7 @@ namespace senf {
 
         static void exit(unsigned code=0); ///< Terminate daemon with failure
 
-        void logReopen();               ///< Reopen the log files
+        void logReopen();               ///< Reopen the %log files
                                         /**< This is used when rotating the logs. By default,
                                              SIGHUP calls logReopen. */