Merge branch 'master' of gnunet.org:gnunet
[oweals/gnunet.git] / src / include / gnunet_program_lib.h
index c89212dcb071f068f8c19a14024eb25e08ef2abb..c434c917003fe18574053e474ee1909e15e5117f 100644 (file)
@@ -1,28 +1,31 @@
 /*
      This file is part of GNUnet.
-     Copyright (C) 2001-2013 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 3, 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
- * @defgroup program functions for writing command-line programs
+ *
+ * @file
+ * Functions related to starting programs
+ *
+ * @defgroup program  Program library
+ * Start command-line programs.
  * @{
  */
 
@@ -49,10 +52,11 @@ 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);
 
 
 /**
@@ -71,11 +75,15 @@ typedef void (*GNUNET_PROGRAM_Main) (void *cls, char *const *args,
  * @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);
+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);
+
 
 /**
  * Run a standard GNUnet command startup sequence (initialize loggers
@@ -91,11 +99,13 @@ GNUNET_PROGRAM_run2 (int argc, char *const *argv, const char *binaryName,
  * @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 */
@@ -105,8 +115,9 @@ GNUNET_PROGRAM_run (int argc, char *const *argv, const char *binaryName,
 }
 #endif
 
-/** @} */ /* end of group program */
-
 /* ifndef GNUNET_PROGRAM_LIB_H */
 #endif
+
+/** @} */  /* end of group program */
+
 /* end of gnunet_program_lib.h */