Add cheatsheet, text version of man page

3 files changed, 119 insertions, 0 deletions

diff --git a/src/Makefile-files b/src/Makefile-files
index 886d248..4281ec9 100644
--- a/src/Makefile-files
+++ b/src/Makefile-files
@@ -4,3 +4,8 @@ EXTRA_DIST  += src/git-amb
 
 man_MANS   += src/git-amb.1
 EXTRA_DIST += src/git-amb.1.in
+
+EXTRA_DIST += src/git-amb.txt
+if HAVE_NDIM_MAN2TXT
+UPDATE_SOURCE_FILES += src/git-amb.txt
+endif
diff --git a/src/git-amb.1.in b/src/git-amb.1.in
index 0461368..81065b5 100644
--- a/src/git-amb.1.in
+++ b/src/git-amb.1.in
@@ -75,6 +75,20 @@ The branch name will be appended to it.
   $ git-amb sh
   <----> [...] $ ls *.tar.gz
 .fi
+.SH "TODO"
+.TP
+.B "Access to build results"
+Could be better.
+.TP
+.B "User Interface"
+Should be more consistent, smaller.
+.TP
+.B "Concurrent Usage"
+Exhibits problems, e.g. starting
+.B "git\-amb sh"
+and then running
+.B "git checkout other\-branch"
+from another terminal.
 .SH AUTHORS
 .B "git\-amb"
 was written by Hans Ulrich Niedermann.
diff --git a/src/git-amb.txt b/src/git-amb.txt
new file mode 100644
index 0000000..cbd01dc
--- /dev/null
+++ b/src/git-amb.txt
@@ -0,0 +1,100 @@
+GIT-AMB(1)		   ndims git utilities 1.1.1		    GIT-AMB(1)
+
+
+
+NAME
+       git-amb - git automake build utitilty
+
+SYNOPSIS
+       git-amb command [params]
+
+DESCRIPTION
+       Build  automake based git checkout in branch specific build and install
+       trees.  That makes it easy to  compare  build  results  from  different
+       branches.
+
+COMMAND OVERVIEW
+       git-amb autoreconf [params...]
+	      Run autoreconf on ${top_srcdir}.	Optional params will be passed
+	      on to autoreconf.
+
+       git-amb configure [params...]
+	      Run configure  in	 ${top_builddir}.   Optional  params  will  be
+	      passed on to configure.
+
+       git-amb make [params...]
+	      Run  make in ${top_builddir}.  Optional params will be passed on
+	      to make.
+
+       git-amb sh [params...]
+	      Start shell in ${top_builddir}.  Optional params will be	passed
+	      on to the shell.
+
+       git-amb clean [branch]
+	      Run ’make clean’ in ${top_builddir}.  The optional branch is the
+	      branch to clean up.
+
+       git-amb distclean [branch]
+	      Run ’make distclean’ in ${top_builddir}.	The optional branch is
+	      the branch to clean up.
+
+       git-amb purge [branch]
+	      Remove  both build and install tree.  The optional branch is the
+	      branch to purge.
+
+       git-amb uninstall [branch]
+	      Remove ${installdir}.  The optional  branch  is  the  branch  to
+	      uninstall.
+
+       git-amb builddir [branch]
+	      Print  ${builddir}.   The optional branch is the branch to print
+	      the builddir for.
+
+       git-amb installdir [branch]
+	      Print ${installdir}.  The optional branch is the branch to print
+	      the installdir for.
+
+CONFIGURATION
+       Get the value with git config amb.foo or set it with git config amb.foo
+       value
+
+   amb.builddir
+       Location of build tree, relative to top checkout (source) dir, or abso-
+       lute.  The branch name will be appended to it.
+
+   amb.installdir
+       Location	 of  installation,  relative  to top checkout (source) dir, or
+       absolute.  The branch name will be appended to it.
+
+EXAMPLES
+	 $ git config amb.builddir _builds
+	 $ git config amb.installdir _installs
+
+	 $ git checkout master
+	 $ git-amb make install
+	 $ git checkout foo/bar
+	 $ git-amb make dist install
+	 $ diff -ru $(git-amb installdir) $(git-amb installdir master)
+	 $ git-amb sh
+	 <----> [...] $ ls *.tar.gz
+
+TODO
+       Access to build results
+	      Could be better.
+
+       User Interface
+	      Should be more consistent, smaller.
+
+       Concurrent Usage
+	      Exhibits problems, e.g. starting git-amb sh and then running git
+	      checkout other-branch from another terminal.
+
+AUTHORS
+       git-amb was written by Hans Ulrich Niedermann.
+
+SEE ALSO
+       git-branch(1), git-checkout(1), git-config(1).
+
+
+
+2007-11-02		     ndim-git-utils 1.1.1		    GIT-AMB(1)