[pacman-dev] [PATCH v3 8/8] bacman: add manual page

[Gordian Edenhofer]

Signed-off-by: Gordian Edenhofer <gordian.edenhofer at gmail.com>
---
 contrib/doc/.gitignore   |  1 +
 contrib/doc/Makefile.am  |  5 +++-
 contrib/doc/bacman.8.txt | 71 ++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 76 insertions(+), 1 deletion(-)
 create mode 100644 contrib/doc/bacman.8.txt

diff --git a/contrib/doc/.gitignore b/contrib/doc/.gitignore
index c5612bc..3ab2035 100644
--- a/contrib/doc/.gitignore
+++ b/contrib/doc/.gitignore
@@ -1 +1,2 @@
 verify-pacman-repo-db.1
+bacman.8
diff --git a/contrib/doc/Makefile.am b/contrib/doc/Makefile.am
index 4c316bb..d5725b1 100644
--- a/contrib/doc/Makefile.am
+++ b/contrib/doc/Makefile.am
@@ -4,12 +4,14 @@
 # man_MANS if --enable-asciidoc and/or --enable-doxygen are used.
 
 ASCIIDOC_MANS = \
-	verify-pacman-repo-db.1
+	verify-pacman-repo-db.1 \
+	bacman.8
 
 EXTRA_DIST = \
 	asciidoc.conf \
 	footer.txt \
 	verify-pacman-repo-db.1.txt \
+	bacman.8.txt \
 	$(ASCIIDOC_MANS)
 
 # Files that should be removed, but which Automake does not know.
@@ -53,5 +55,6 @@ $(ASCIIDOC_MANS): asciidoc.conf footer.txt Makefile.am
 
 # Dependency rules
 verify-pacman-repo-db.1: verify-pacman-repo-db.1.txt
+bacman.8: bacman.8.txt
 
 # vim:set noet:
diff --git a/contrib/doc/bacman.8.txt b/contrib/doc/bacman.8.txt
new file mode 100644
index 0000000..2c3112f
--- /dev/null
+++ b/contrib/doc/bacman.8.txt
@@ -0,0 +1,71 @@
+/////
+vim:set ts=4 sw=4 syntax=asciidoc noet spell spelllang=en_us:
+/////
+bacman(8)
+==========
+
+Name
+----
+bacman - reassemble installed packages
+
+
+Synopsis
+--------
+'bacman' [options] <package(s)>
+
+
+Description
+-----------
+'bacman' was designed to reassemble installed packages from its deliverd files.
+It comes in handy if there is no internet connection available and you have no
+access to a up-to-date package cache. Otherwise packages from the Arch Linux
+Archive should always be preferred.
+
+'bacman' fully honors linkman:makepkg.conf[8] and all compression environment
+variables, notably ``XZ_OPT''.
+
+
+Options
+-------
+*-h, \--help*::
+	Display usage information.
+
+*-q, \--quiet*::
+	Silence most of the status reporting.
+
+*\--nocolor*::
+	Disable colored output.
+
+*\--pacnew*::
+	Package .pacnew files instead of the concerning files currently in place.
+
+*-j, \--jobs <jobs>*::
+	Assemble multiple packages in parallel.
+
+*-o, \--out <dir>*::
+	Write the assembled package(s) to the specified directory.
+
+
+Examples
+--------
+'bacman' linux-headers
+
+Recreate the package ``linux-headers''.
+
+'bacman' gzip munge binutils -o ~/Downloads
+
+Assemble the packages gzip munge binutils and place the packages at
+``~/Downloads''.
+
+'bacman' --nocolor --pacnew -o ~/backup -j 5 $(pacman -Qsq)
+
+Assemble all currently installed packages using 5 concurrent jobs, use
+``.pacnew'' whenever available, suppress colored output and place the desired
+packages in ``~/backup''.
+
+
+See Also
+--------
+linkman:makepkg[8], linkman:pacman[8]
+
+include::footer.txt[]
-- 
2.9.3