From 078e20885e0805e04669f9b334a516a6d8d12763 Mon Sep 17 00:00:00 2001
From: Eelco Dolstra <e.dolstra@tudelft.nl>
Date: Mon, 1 Dec 2003 15:55:05 +0000
Subject: * Help text for all (non-script) programs, so no more:

$ nix-instantiate --help
error: unknown flag `--help`
Try `nix-instantiate --help' for more information.

:-)
---
 src/libmain/shared.hh | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'src/libmain/shared.hh')

diff --git a/src/libmain/shared.hh b/src/libmain/shared.hh
index 8ea637fd21ac..76b639e3785d 100644
--- a/src/libmain/shared.hh
+++ b/src/libmain/shared.hh
@@ -6,8 +6,17 @@
 #include "util.hh"
 
 
+/* These are not implemented here, but must be implemented by a
+   program linking against libmain. */
+
+/* Main program.  Called by main() after the ATerm library has been
+   initialised and some default arguments have been processed (and
+   removed from `args').  main() will catch all exceptions. */
 void run(Strings args);
 
+/* Should print a help message to stdout and return. */
+void printHelp();
+
 
 extern string programId;
 
-- 
cgit 1.4.1