From: Ram Bhamidipaty <rambham@gmail.com> Patch to add docs for the pactree utility. This version includes feedback from Allan McRae and Andrew Gregory. Also removed duplicate entries for -c. Signed-off-by: Ram Bhamidipaty <rambham@gmail.com> --- doc/.gitignore | 1 + doc/Makefile.am | 8 +++++-- doc/pactree.8.txt | 62 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 69 insertions(+), 2 deletions(-) create mode 100644 doc/pactree.8.txt diff --git a/doc/.gitignore b/doc/.gitignore index 5625735..a96ddb3 100644 --- a/doc/.gitignore +++ b/doc/.gitignore @@ -5,6 +5,7 @@ makepkg.conf.5 pacman.8 pacman-key.8 pacman.conf.5 +pactree.8 pkgdelta.8 repo-add.8 repo-remove.8 diff --git a/doc/Makefile.am b/doc/Makefile.am index e6ed29c..2c08de5 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -13,7 +13,8 @@ ASCIIDOC_MANS = \ PKGBUILD.5 \ makepkg.conf.5 \ pacman.conf.5 \ - libalpm.3 + libalpm.3 \ + pactree.8 DOXYGEN_MANS = $(wildcard man3/*.3) @@ -27,7 +28,8 @@ HTML_MANPAGES = \ PKGBUILD.5.html \ makepkg.conf.5.html \ pacman.conf.5.html \ - libalpm.3.html + libalpm.3.html \ + pactree.8.html HTML_OTHER = \ index.html \ @@ -53,6 +55,7 @@ EXTRA_DIST = \ makepkg.conf.5.txt \ pacman.conf.5.txt \ libalpm.3.txt \ + pactree.8.txt \ footer.txt \ index.txt \ submitting-patches.txt \ @@ -152,6 +155,7 @@ 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 libalpm.3 libalpm.3.html: libalpm.3.txt +pactree.8 pactree.8.html: pactree.8.txt # this one is just a symlink repo-remove.8: repo-add.8 $(RM) repo-remove.8 diff --git a/doc/pactree.8.txt b/doc/pactree.8.txt new file mode 100644 index 0000000..0cba7b5 --- /dev/null +++ b/doc/pactree.8.txt @@ -0,0 +1,62 @@ +///// +vim:set ts=4 sw=4 syntax=asciidoc noet spell spelllang=en_us: +///// +pactree(8) +========= + +Name +---- +pactree - package dependency tree viewer + + +Synopsis +-------- +'pactree' [options] package + +Description +----------- +Pactree produces a dependency tree for a package. + +By default a tree like output is generated, but with the -g option a graphviz +description is generated. + +Options +------- +*-c, \--color*:: + Colorize output. + +*-b, \--dbpath*:: + Specify an alternative database location. + +*-d, \--depth <num>*:: + Limits the number of levels of dependency to show. A zero means + show the named package only, one shows the packages that are directly + required. + +*-g, \--graph*:: + Generate graphviz description. If this option is given, the -c and -l + options are ignored. + +*-h, \--help*:: + Output syntax and command line options. + +*-l, \--linear*:: + Prints package names at the start of each line, one per line. + +*-r, \--reverse*:: + Show packages that depend on the named package. + +*-s, \--sync*:: + Read package data from sync databases instead of local database. + +*-u, \--unique*:: + List dependent packages once. Implies --linear. + +*\--config <file>*:: + Specify an alternate pacman configuration file. + +See Also +-------- +linkman:pacman[8], linkman:pacman.conf[5], linkman:makepkg[8] + +include::footer.txt[] -- 1.7.11