about summary refs log tree commit diff
path: root/src/libmain/shared.hh
diff options
context:
space:
mode:
authorEelco Dolstra <e.dolstra@tudelft.nl>2003-12-01T15·55+0000
committerEelco Dolstra <e.dolstra@tudelft.nl>2003-12-01T15·55+0000
commit078e20885e0805e04669f9b334a516a6d8d12763 (patch)
treef16741a27866a46806c99ec8d5c8371ae5298046 /src/libmain/shared.hh
parent905d5b91fa6fa64e549f9019f9fab4150f00c13a (diff)
* Help text for all (non-script) programs, so no more:
$ nix-instantiate --help
error: unknown flag `--help`
Try `nix-instantiate --help' for more information.

:-)

Diffstat (limited to 'src/libmain/shared.hh')
-rw-r--r--src/libmain/shared.hh9
1 files changed, 9 insertions, 0 deletions
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;