[pacman-dev] [PATCH] [RFC] Add bacman manpage, fix #36419
From: Pablo Lezaeta <prflr88@gmail.com> This add bacman manpage (if I'm not missing something) for bacman. I think this manpage could be improved, but for a first draft (and a RFC) is ok. Signed-off-by: Pablo Lezaeta <prflr88@gmail.com> --- doc/Makefile.am | 4 ++++ doc/bacman.8.txt | 36 ++++++++++++++++++++++++++++++++++++ doc/index.txt | 1 + 3 files changed, 41 insertions(+) create mode 100644 doc/bacman.8.txt diff --git a/doc/Makefile.am b/doc/Makefile.am index a7908df..30fc672 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -4,6 +4,7 @@ # man_MANS if --enable-asciidoc and/or --enable-doxygen are used. ASCIIDOC_MANS = \ + bacman.8 \ pacman.8 \ makepkg.8 \ makepkg-template.1 \ @@ -20,6 +21,7 @@ ASCIIDOC_MANS = \ DOXYGEN_MANS = $(wildcard man3/*.3) HTML_MANPAGES = \ + bacman.8.html \ pacman.8.html \ makepkg.8.html \ makepkg-template.1.html \ @@ -46,6 +48,7 @@ HTML_DOCS = \ EXTRA_DIST = \ asciidoc.conf \ asciidoc-override.css \ + bacman.8.txt \ pacman.8.txt \ makepkg.8.txt \ makepkg-template.1.txt \ @@ -148,6 +151,7 @@ $(HTML_OTHER): asciidoc.conf Makefile.am %.3.html: ASCIIDOC_OPTS += -d manpage # Dependency rules +bacman.8 bacman.8.html: bacman.8.txt pacman.8 pacman.8.html: pacman.8.txt makepkg.8 makepkg.8.html: makepkg.8.txt makepkg-template.1 makepkg-template.1.html: makepkg-template.1.txt diff --git a/doc/bacman.8.txt b/doc/bacman.8.txt new file mode 100644 index 0000000..c677fc0 --- /dev/null +++ b/doc/bacman.8.txt @@ -0,0 +1,36 @@ +///// +vim:set ts=4 sw=4 syntax=asciidoc noet spell spelllang=en_us: +///// +bacman(8) +========= + + +Name +---- +bacman - recreates a package using pacman's db and system files + + +Synopsis +-------- +'bacman' [options] installed-package-name + +Description +----------- +recreates a package using pacman's db and system files + +Options +------- +*-h, \--help*:: + Output syntax and command line options. + +*-v, \--version*:: + Output version of bacman and exit. + +*\--nocolor*:: + Output without colors. + +See Also +-------- +linkman:pacman[8] + +include::footer.txt[] \ No newline at end of file diff --git a/doc/index.txt b/doc/index.txt index ab1dc79..1b611bc 100644 --- a/doc/index.txt +++ b/doc/index.txt @@ -43,6 +43,7 @@ configuration files dealing with pacman. * linkman:libalpm[3] * linkman:makepkg[8] * linkman:makepkg.conf[5] +* linkman:bacman[8] * linkman:pacman[8] * linkman:pacman-key[8] * linkman:pacman.conf[5] -- 2.0.0
On 12/06/14 14:37, prflr88@gmail.com wrote:
From: Pablo Lezaeta <prflr88@gmail.com>
This add bacman manpage (if I'm not missing something) for bacman. I think this manpage could be improved, but for a first draft (and a RFC) is ok.
Man page looks fine. This should only be installed when contrib is installed. And we do not have a nice target for that (currently we need to do "make -C contrib install"). So the first step we need is to add a toplevel "make install-contrib" target and then have that install the bacman manpage. Allan
Signed-off-by: Pablo Lezaeta <prflr88@gmail.com> --- doc/Makefile.am | 4 ++++ doc/bacman.8.txt | 36 ++++++++++++++++++++++++++++++++++++ doc/index.txt | 1 + 3 files changed, 41 insertions(+) create mode 100644 doc/bacman.8.txt
diff --git a/doc/Makefile.am b/doc/Makefile.am index a7908df..30fc672 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -4,6 +4,7 @@ # man_MANS if --enable-asciidoc and/or --enable-doxygen are used.
ASCIIDOC_MANS = \ + bacman.8 \ pacman.8 \ makepkg.8 \ makepkg-template.1 \ @@ -20,6 +21,7 @@ ASCIIDOC_MANS = \ DOXYGEN_MANS = $(wildcard man3/*.3)
HTML_MANPAGES = \ + bacman.8.html \ pacman.8.html \ makepkg.8.html \ makepkg-template.1.html \ @@ -46,6 +48,7 @@ HTML_DOCS = \ EXTRA_DIST = \ asciidoc.conf \ asciidoc-override.css \ + bacman.8.txt \ pacman.8.txt \ makepkg.8.txt \ makepkg-template.1.txt \ @@ -148,6 +151,7 @@ $(HTML_OTHER): asciidoc.conf Makefile.am %.3.html: ASCIIDOC_OPTS += -d manpage
# Dependency rules +bacman.8 bacman.8.html: bacman.8.txt pacman.8 pacman.8.html: pacman.8.txt makepkg.8 makepkg.8.html: makepkg.8.txt makepkg-template.1 makepkg-template.1.html: makepkg-template.1.txt diff --git a/doc/bacman.8.txt b/doc/bacman.8.txt new file mode 100644 index 0000000..c677fc0 --- /dev/null +++ b/doc/bacman.8.txt @@ -0,0 +1,36 @@ +///// +vim:set ts=4 sw=4 syntax=asciidoc noet spell spelllang=en_us: +///// +bacman(8) +========= + + +Name +---- +bacman - recreates a package using pacman's db and system files + + +Synopsis +-------- +'bacman' [options] installed-package-name + +Description +----------- +recreates a package using pacman's db and system files + +Options +------- +*-h, \--help*:: + Output syntax and command line options. + +*-v, \--version*:: + Output version of bacman and exit. + +*\--nocolor*:: + Output without colors. + +See Also +-------- +linkman:pacman[8] + +include::footer.txt[] \ No newline at end of file diff --git a/doc/index.txt b/doc/index.txt index ab1dc79..1b611bc 100644 --- a/doc/index.txt +++ b/doc/index.txt @@ -43,6 +43,7 @@ configuration files dealing with pacman. * linkman:libalpm[3] * linkman:makepkg[8] * linkman:makepkg.conf[5] +* linkman:bacman[8] * linkman:pacman[8] * linkman:pacman-key[8] * linkman:pacman.conf[5]
participants (2)
-
Allan McRae
-
prflr88@gmail.com