2 This file is part of GNUnet.
3 Copyright (C) 2001-2013 Christian Grothoff (and other contributing authors)
5 GNUnet is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published
7 by the Free Software Foundation; either version 3, or (at your
8 option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with GNUnet; see the file COPYING. If not, write to the
17 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18 Boston, MA 02110-1301, USA.
23 * Functions related to starting programs
25 * @author Christian Grothoff
26 * @defgroup program Functions for writing command-line programs
30 #ifndef GNUNET_PROGRAM_LIB_H
31 #define GNUNET_PROGRAM_LIB_H
36 #if 0 /* keep Emacsens' auto-indent happy */
41 #include "gnunet_configuration_lib.h"
42 #include "gnunet_getopt_lib.h"
43 #include "gnunet_scheduler_lib.h"
46 * Main function that will be run.
49 * @param args remaining command-line arguments
50 * @param cfgfile name of the configuration file used (for saving, can be NULL!)
51 * @param cfg configuration
54 (*GNUNET_PROGRAM_Main) (void *cls,
57 const struct GNUNET_CONFIGURATION_Handle *cfg);
61 * Run a standard GNUnet command startup sequence (initialize loggers
62 * and configuration, parse options).
64 * @param argc number of command line arguments in @a argv
65 * @param argv command line arguments
66 * @param binaryName our expected name
67 * @param binaryHelp help text for the program
68 * @param options command line options
69 * @param task main function to run
70 * @param task_cls closure for @a task
71 * @param run_without_scheduler #GNUNET_NO start the scheduler,
72 * #GNUNET_YES do not start the scheduler just run the main task
73 * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
76 GNUNET_PROGRAM_run2 (int argc,
78 const char *binaryName,
79 const char *binaryHelp,
80 const struct GNUNET_GETOPT_CommandLineOption *options,
81 GNUNET_PROGRAM_Main task,
83 int run_without_scheduler);
86 * Run a standard GNUnet command startup sequence (initialize loggers
87 * and configuration, parse options).
89 * @param argc number of command line arguments
90 * @param argv command line arguments
91 * @param binaryName our expected name
92 * @param binaryHelp helptext for "-h" option (about the app)
93 * @param options command line options
94 * @param task main function to run
95 * @param task_cls closure for @a task
96 * @return #GNUNET_SYSERR on error, #GNUNET_OK on success
99 GNUNET_PROGRAM_run (int argc,
101 const char *binaryName,
102 const char *binaryHelp,
103 const struct GNUNET_GETOPT_CommandLineOption *options,
104 GNUNET_PROGRAM_Main task, void *task_cls);
108 #if 0 /* keep Emacsens' auto-indent happy */
115 /** @} */ /* end of group program */
117 /* ifndef GNUNET_PROGRAM_LIB_H */
119 /* end of gnunet_program_lib.h */