summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHans Ulrich Niedermann <hun@n-dimensional.de>2008-02-14 12:05:19 +0100
committerHans Ulrich Niedermann <hun@n-dimensional.de>2008-02-14 12:05:19 +0100
commit4a5d82f451f5baae63bfd350e9573d1069dd77df (patch)
tree1c06e58b8d18385f78389c7dee1c3c67ab41667a
parentf4ee0aafd62cac45f54fda710e78a76f1b71d480 (diff)
downloadndim-git-utils-4a5d82f451f5baae63bfd350e9573d1069dd77df.tar.gz
ndim-git-utils-4a5d82f451f5baae63bfd350e9573d1069dd77df.tar.xz
ndim-git-utils-4a5d82f451f5baae63bfd350e9573d1069dd77df.zip
Document possible cmdline user interface
-rw-r--r--nbb/nbb_lib.in24
1 files changed, 24 insertions, 0 deletions
diff --git a/nbb/nbb_lib.in b/nbb/nbb_lib.in
index 1ef7850..3296ff0 100644
--- a/nbb/nbb_lib.in
+++ b/nbb/nbb_lib.in
@@ -14,6 +14,30 @@ TODO:
* run 'make' type step
* run 'make install' type step
* run custom (make) commands
+
+ * Bash syntax completion for that user interface.
+
+ * Man page or something similar.
+
+Possible interface:
+
+ $ nbb [general options] init [command specific options]
+ $ nbb [general options] configure [command specific options]
+ $ nbb [general options] build [command specific options]
+ $ nbb [general options] install [command specific options]
+
+ $ nbb [general options] config srcdir
+ $ nbb [general options] config builddir [<builddir>]
+ $ nbb [general options] config installdir [<installdir>]
+
+ $ nbb [general options] src-sh [command specific options]
+ $ nbb [general options] build-sh [command specific options]
+ $ nbb [general options] install-sh [command specific options]
+
+ $ nbb [general options] run <command> [<param>...]
+ $ nbb [general options] run [command specific options... <-->] <command> [<param>...]
+
+
"""
import sys