doxygen fix
[oweals/gnunet.git] / src / template / gnunet-template.c
1 /*
2      This file is part of GNUnet.
3      (C) 2001, 2002, 2004, 2005, 2006, 2007, 2009 Christian Grothoff (and other contributing authors)
4
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.
9
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.
14
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., 59 Temple Place - Suite 330,
18      Boston, MA 02111-1307, USA.
19 */
20
21 /**
22  * @file template/gnunet-template.c
23  * @brief template for writing a tool
24  * @author Christian Grothoff
25  */
26 #include "platform.h"
27 #include "gnunet_getopt_lib.h"
28 #include "gnunet_program_lib.h"
29 /* #include "gnunet_template_service.h" */
30
31 /**
32  * Final status code.
33  */
34 static int ret;
35
36 /**
37  * Main function that will be run by the scheduler.
38  *
39  * @param cls closure
40  * @param args remaining command-line arguments
41  * @param cfgfile name of the configuration file used (for saving, can be NULL!)
42  * @param cfg configuration
43  */
44 static void
45 run (void *cls, char *const *args, const char *cfgfile,
46      const struct GNUNET_CONFIGURATION_Handle *cfg)
47 {
48   /* main code here */
49 }
50
51
52 /**
53  * The main function.
54  *
55  * @param argc number of arguments from the command line
56  * @param argv command line arguments
57  * @return 0 ok, 1 on error
58  */
59 int
60 main (int argc, char *const *argv)
61 {
62   static const struct GNUNET_GETOPT_CommandLineOption options[] = {
63     /* FIMXE: add options here */
64     GNUNET_GETOPT_OPTION_END
65   };
66   return (GNUNET_OK ==
67           GNUNET_PROGRAM_run (argc, argv, "gnunet-template",
68                               gettext_noop ("help text"), options, &run,
69                               NULL)) ? ret : 1;
70 }
71
72 /* end of gnunet-template.c */