summaryrefslogtreecommitdiffstats
path: root/mmain.h
diff options
context:
space:
mode:
Diffstat (limited to 'mmain.h')
-rw-r--r--mmain.h45
1 files changed, 45 insertions, 0 deletions
diff --git a/mmain.h b/mmain.h
new file mode 100644
index 00000000..6cb6ea39
--- /dev/null
+++ b/mmain.h
@@ -0,0 +1,45 @@
+/* $Id$ */
+/*
+ * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
+ *
+ * Permission to use, copy, modify, and distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the
+ * above copyright notice and this permission notice appear in all
+ * copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
+ * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
+ * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
+ * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
+ * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
+ * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+ * PERFORMANCE OF THIS SOFTWARE.
+ */
+#ifndef MMAIN_H
+#define MMAIN_H
+
+/*
+ * This is a convenience library for utilities implementing mdoc(3)
+ * accepting a similar set of command-line patterns. mmain handles
+ * error reporting (to the terminal), preparing and reading the input
+ * file, and enacting the parse itself.
+ */
+
+#include "mdoc.h"
+
+__BEGIN_DECLS
+
+struct mmain;
+
+struct mmain *mmain_alloc(void);
+__dead void mmain_exit(struct mmain *, int);
+int mmain_getopt(struct mmain *, int,
+ char *[], const char *);
+int mmain_isopt(int);
+struct mdoc *mmain_mdoc(struct mmain *);
+void mmain_usage(const char *);
+
+__END_DECLS
+
+#endif /*!MMAIN_H*/