[pacman-dev] [PATCH v2 3/3] bacman: add manual page
Gordian Edenhofer
gordian.edenhofer at gmail.com
Sun Aug 14 20:39:56 UTC 2016
Signed-off-by: Gordian Edenhofer <gordian.edenhofer at gmail.com>
---
* Fix some typos
* Adjust man page according to v2 of this patch series
doc/.gitignore | 1 +
doc/Makefile.am | 4 ++++
doc/bacman.8.txt | 71 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
3 files changed, 76 insertions(+)
create mode 100644 doc/bacman.8.txt
diff --git a/doc/.gitignore b/doc/.gitignore
index 2eae9e4..80d0026 100644
--- a/doc/.gitignore
+++ b/doc/.gitignore
@@ -7,6 +7,7 @@ makepkg.conf.5
pacman.8
pacman-key.8
pacman.conf.5
+bacman.8
pactree.8
pkgdelta.8
repo-add.8
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 5d7c975..88f23cc 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -13,6 +13,7 @@ ASCIIDOC_MANS = \
pkgdelta.8 \
pacman-key.8 \
pactree.8 \
+ bacman.8 \
PKGBUILD.5 \
makepkg.conf.5 \
pacman.conf.5 \
@@ -30,6 +31,7 @@ HTML_MANPAGES = \
pkgdelta.8.html \
pacman-key.8.html \
pactree.8.html \
+ bacman.8.html \
PKGBUILD.5.html \
makepkg.conf.5.html \
pacman.conf.5.html \
@@ -57,6 +59,7 @@ EXTRA_DIST = \
pkgdelta.8.txt \
pacman-key.8.txt \
pactree.8.txt \
+ bacman.8.txt \
PKGBUILD.5.txt \
PKGBUILD-example.txt \
makepkg.conf.5.txt \
@@ -160,6 +163,7 @@ vercmp.8 vercmp.8.html: vercmp.8.txt
pkgdelta.8 pkgdelta.8.html: pkgdelta.8.txt
pacman-key.8 pacman-key.8.html: pacman-key.8.txt
pactree.8 pactree.8.html: pactree.8.txt
+bacman.8 bacman.8.html: bacman.8.txt
PKGBUILD.5 PKGBUILD.5.html: PKGBUILD.5.txt PKGBUILD-example.txt
makepkg.conf.5 makepkg.conf.5.html: makepkg.conf.5.txt
pacman.conf.5 pacman.conf.5.html: pacman.conf.5.txt
diff --git a/doc/bacman.8.txt b/doc/bacman.8.txt
new file mode 100644
index 0000000..f66e9c2
--- /dev/null
+++ b/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''.
+
+$myname --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.2
More information about the pacman-dev
mailing list