summaryrefslogtreecommitdiffstats
path: root/contrib
diff options
context:
space:
mode:
authorGordian Edenhofer <gordian.edenhofer@gmail.com>2016-09-04 18:14:06 +0200
committerAllan McRae <allan@archlinux.org>2016-09-25 09:41:10 +0200
commitae56a32273df8a36f4e84e0f37ce1f34e84f15a3 (patch)
treef1aafdb4dfaea77b7e7839dfa3aa8c2eaa0ead7c /contrib
parent5fcc054421a4ec4f1928f2598beb4ef54bb75fbc (diff)
downloadpacman-ae56a32273df8a36f4e84e0f37ce1f34e84f15a3.tar.gz
pacman-ae56a32273df8a36f4e84e0f37ce1f34e84f15a3.tar.xz
bacman: add manual page
Signed-off-by: Gordian Edenhofer <gordian.edenhofer@gmail.com> Signed-off-by: Allan McRae <allan@archlinux.org>
Diffstat (limited to 'contrib')
-rw-r--r--contrib/doc/.gitignore1
-rw-r--r--contrib/doc/Makefile.am5
-rw-r--r--contrib/doc/bacman.8.txt67
3 files changed, 72 insertions, 1 deletions
diff --git a/contrib/doc/.gitignore b/contrib/doc/.gitignore
index c5612bca..3ab20353 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 4c316bb7..d5725b1e 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 00000000..dc5af481
--- /dev/null
+++ b/contrib/doc/bacman.8.txt
@@ -0,0 +1,67 @@
+/////
+vim:set ts=4 sw=4 syntax=asciidoc noet spell spelllang=en_us:
+/////
+bacman(8)
+==========
+
+Name
+----
+bacman - recreate installed packages
+
+
+Synopsis
+--------
+'bacman' [options] <package(s)>
+
+
+Description
+-----------
+'bacman' was designed to reassemble installed packages using pacman's database
+and system files.
+It is useful for regenerating an installed package that you are unable to
+download that is also not available in your package cache.
+
+'bacman' honors packaging settings from linkman:makepkg.conf[8].
+
+
+Options
+-------
+*-h, \--help*::
+ Display usage information.
+
+*-q, \--quiet*::
+ Silence most of the status reporting.
+
+*-m, \--nocolor*::
+ Disable colored output.
+
+*-o, \--out <dir>*::
+ Write the assembled package(s) to the specified directory.
+
+*\--pacnew*::
+ Package `.pacnew` files if available instead of the (possibly modified)
+ versions in place on the filesystem.
+
+
+Examples
+--------
+
+The following are example usages of the 'bacman' utility:
+
+$ bacman linux-headers::
+ Recreate the package ``linux-headers''.
+
+$ bacman gzip make binutils -o ~/packages::
+ Assemble the packages ``gzip'', ``make'', and ``binutils'' and place
+ the packages in the ``~/packages'' directory.
+
+$ bacman --nocolor --pacnew -o ~/backup $(pacman -Qq)::
+ Assemble all currently installed packages using ``.pacnew'' whenever
+ available, suppress colored output and place the desired packages in
+ the ``~/backup''. directory
+
+See Also
+--------
+linkman:makepkg[8], linkman:pacman[8]
+
+include::footer.txt[]