bacman: add manual page

Signed-off-by: Gordian Edenhofer <gordian.edenhofer@gmail.com>
Signed-off-by: Allan McRae <allan@archlinux.org>
This commit is contained in:
Gordian Edenhofer 2016-09-04 18:14:06 +02:00 committed by Allan McRae
parent 5fcc054421
commit ae56a32273
3 changed files with 72 additions and 1 deletions

View File

@ -1 +1,2 @@
verify-pacman-repo-db.1
bacman.8

View File

@ -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:

67
contrib/doc/bacman.8.txt Normal file
View File

@ -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[]