Bumped version to 3.11.7; Updated ChangeLog.

[collectd.git] / src / configfile.h

diff --git a/src/configfile.h b/src/configfile.h
index 0802ba5..0bb11b2 100644 (file)
--- a/src/configfile.h
+++ b/src/configfile.h
@@ -1,6 +1,6 @@
 /**
  * collectd - src/configfile.h
- * Copyright (C) 2005  Florian octo Forster
+ * Copyright (C) 2005,2006  Florian octo Forster
  *
  * This program is free software; you can redistribute it and/or modify it
  * under the terms of the GNU General Public License as published by the
@@ -37,7 +37,7 @@ void cf_unregister (char *type);
  * DESCRIPTION
  *  `cf_register' is called by plugins that wish to receive config keys. The
  *  plugin will then receive all keys it registered for if they're found in a
- *  `<Moudle $type>' section.
+ *  `<Plugin $type>' section.
  *
  * PARAMETERS
  *  `type'      Name of the plugin (must be the same as passed to
@@ -63,10 +63,30 @@ void cf_register (char *type,
 
 /*
  * DESCRIPTION
+ *  `cf_get_option' returns various general options.
+ *
+ * PARAMETERS
+ *  `key'       Name of the option to query.
+ *  `def'       Pointer to return as default value.
+ *
+ * RETURN VALUE
+ *  The pointer returned is part of an internal structure and may not be
+ *  changed. If the option is not found for whatever reason (wrong key, option
+ *  not allowed for currently selected mode, ...) `NULL' is returned.
+ */
+char *cf_get_option (const char *key, char *def);
+
+/*
+ * DESCRIPTION
  *  `cf_read' reads the config file `filename' and dispatches the read
  *  information to functions/variables. Most important: Is calls `plugin_load'
  *  to load specific plugins, depending on the current mode of operation.
  *
+ * PARAMETERS
+ *  `filename'  An additional filename to look for. This function calls
+ *              `lc_process' which already searches many standard locations..
+ *              If set to NULL will use the `CONFIGFILE' define.
+ *
  * RETURN VALUE
  *  Returns zero upon success and non-zero otherwise. A error-message will have
  *  been printed in this case.