Merge branch 'master' of gnunet.org:gnunet

[oweals/gnunet.git] / src / include / gnunet_program_lib.h

diff --git a/src/include/gnunet_program_lib.h b/src/include/gnunet_program_lib.h
index 48d5280eec744c9fe4ca844fd69ed0e05b3e90b0..c434c917003fe18574053e474ee1909e15e5117f 100644 (file)
--- a/src/include/gnunet_program_lib.h
+++ b/src/include/gnunet_program_lib.h
@@ -1,27 +1,32 @@
 /*
      This file is part of GNUnet.
-     (C) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2009 Christian Grothoff (and other contributing authors)
+     Copyright (C) 2001-2013 GNUnet e.V.
 
-     GNUnet is free software; you can redistribute it and/or modify
-     it under the terms of the GNU General Public License as published
-     by the Free Software Foundation; either version 2, or (at your
-     option) any later version.
+     GNUnet is free software: you can redistribute it and/or modify it
+     under the terms of the GNU Affero General Public License as published
+     by the Free Software Foundation, either version 3 of the License,
+     or (at your option) any later version.
 
      GNUnet is distributed in the hope that it will be useful, but
      WITHOUT ANY WARRANTY; without even the implied warranty of
      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-     General Public License for more details.
+     Affero General Public License for more details.
+    
+     You should have received a copy of the GNU Affero General Public License
+     along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-     You should have received a copy of the GNU General Public License
-     along with GNUnet; see the file COPYING.  If not, write to the
-     Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-     Boston, MA 02111-1307, USA.
+     SPDX-License-Identifier: AGPL3.0-or-later
 */
 
 /**
- * @file include/gnunet_program_lib.h
- * @brief functions related to starting programs
  * @author Christian Grothoff
+ *
+ * @file
+ * Functions related to starting programs
+ *
+ * @defgroup program  Program library
+ * Start command-line programs.
+ * @{
  */
 
 #ifndef GNUNET_PROGRAM_LIB_H
@@ -47,10 +52,37 @@ extern "C"
  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
  * @param cfg configuration
  */
-typedef void (*GNUNET_PROGRAM_Main) (void *cls, char *const *args,
-                                     const char *cfgfile,
-                                     const struct GNUNET_CONFIGURATION_Handle *
-                                     cfg);
+typedef void
+(*GNUNET_PROGRAM_Main) (void *cls,
+                        char *const *args,
+                        const char *cfgfile,
+                        const struct GNUNET_CONFIGURATION_Handle *cfg);
+
+
+/**
+ * Run a standard GNUnet command startup sequence (initialize loggers
+ * and configuration, parse options).
+ *
+ * @param argc number of command line arguments in @a argv
+ * @param argv command line arguments
+ * @param binaryName our expected name
+ * @param binaryHelp help text for the program
+ * @param options command line options
+ * @param task main function to run
+ * @param task_cls closure for @a task
+ * @param run_without_scheduler #GNUNET_NO start the scheduler,
+ *        #GNUNET_YES do not start the scheduler just run the main task
+ * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
+ */
+int
+GNUNET_PROGRAM_run2 (int argc,
+                     char *const *argv,
+                     const char *binaryName,
+                     const char *binaryHelp,
+                     const struct GNUNET_GETOPT_CommandLineOption *options,
+                     GNUNET_PROGRAM_Main task,
+                     void *task_cls,
+                     int run_without_scheduler);
 
 
 /**
@@ -63,15 +95,17 @@ typedef void (*GNUNET_PROGRAM_Main) (void *cls, char *const *args,
  * @param binaryHelp helptext for "-h" option (about the app)
  * @param options command line options
  * @param task main function to run
- * @param task_cls closure for task
- * @return GNUNET_SYSERR on error, GNUNET_OK on success
+ * @param task_cls closure for @a task
+ * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
  */
 int
-GNUNET_PROGRAM_run (int argc, char *const *argv, const char *binaryName,
+GNUNET_PROGRAM_run (int argc,
+                    char *const *argv,
+                    const char *binaryName,
                     const char *binaryHelp,
                     const struct GNUNET_GETOPT_CommandLineOption *options,
-                    GNUNET_PROGRAM_Main task, void *task_cls);
-
+                    GNUNET_PROGRAM_Main task,
+                   void *task_cls);
 
 
 #if 0                           /* keep Emacsens' auto-indent happy */
@@ -83,4 +117,7 @@ GNUNET_PROGRAM_run (int argc, char *const *argv, const char *binaryName,
 
 /* ifndef GNUNET_PROGRAM_LIB_H */
 #endif
+
+/** @} */  /* end of group program */
+
 /* end of gnunet_program_lib.h */