finch/finch.h

   1 /*
   2  * finch
   3  *
   4  * Finch is the legal property of its developers, whose names are too numerous
   5  * to list here.  Please refer to the COPYRIGHT file distributed with this
   6  * source distribution.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  21  */
  22
  23 #ifndef FINCH_H
  24 #define FINCH_H
  25
  26 /**
  27  * SECTION:finch
  28  * @section_id: finch-finch
  29  * @short_description: <filename>finch.h</filename>
  30  * @title: UI Definitions and Includes
  31  */
  32
  33 #include <glib.h>
  34
  35 #define FINCH_UI "gnt-purple"
  36
  37 #define FINCH_PREFS_ROOT "/finch"
  38
  39 /**
  40  * finch_start:
  41  * @argc: Address of the argc parameter of your main() function (or 0 if argv
  42  *        is %NULL). This will be changed if any arguments were handled.
  43  * @argv: Address of the argv parameter of main(), or %NULL. Any options
  44  *        understood by Finch are stripped before return.
  45  *
  46  * Start finch with the given command line arguments.
  47  */
  48 gboolean finch_start(int *argc, char ***argv);
  49
  50 #endif /* FINCH_H */
  51