Moved `exit_usage' from `collectd.c' to `configfile.c' and renamed it to `cf_callback...

[collectd.git] / src / configfile.h

diff --git a/src/configfile.h b/src/configfile.h
index 0802ba5ad60070e2081bf619f65763f91d4ce6b0..7d89fadbe18504ebc852f74a18da593e545ccfeb 100644 (file)
--- a/src/configfile.h
+++ b/src/configfile.h
@@ -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
@@ -61,16 +61,37 @@ void cf_register (char *type,
                int (*callback) (char *, char *),
                char **keys, int keys_num);
 
+/*
+ * DESCRIPTION
+ *  `cf_get_mode_option' returns options from the <Mode> section(s).
+ *
+ * PARAMETERS
+ *  `key'       Name of the option to query.
+ *
+ * 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_mode_option (const char *key);
+
 /*
  * 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
+ *  `argc'      Same as `argc' passed to `main'
+ *  `argv'      Same as `argv' passed to `main'
+ *  `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.
  */
-int cf_read (char *filename);
+int cf_read (int argc, char **argv, char *filename);
 
 #endif /* defined(CONFIGFILE_H) */