On 25/06/12 08:26, rambham@gmail.com wrote:
From: Ram Bhamidipaty
Signed-off-by: Ram Bhamidipaty
Looks good. Minor comments below.
doc/Makefile.am | 8 +++++-- doc/pactree.8.txt | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 70 insertions(+), 2 deletions(-) create mode 100644 doc/pactree.8.txt
Missing an entry in doc/.gitignore for pactree.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..47dba30 --- /dev/null +++ b/doc/pactree.8.txt @@ -0,0 +1,64 @@ +///// +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. The reverse can also +be shown - packages that depend on the named package. + +By default a tree like output is generated, but with the -g option a graphviz +description is generated.
I think this is really too long. I'd be happy with just: Pactree produces a dependency tree for a package. All the rest is covered in the options.
+Options +------- +*-c, \--color*:: + Colorize output.
An irrelevant aside.... Stupid American spelling! And has the color always been that ugly?
+ +*-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.
If this option is given, the... <- comma
+*-h, \--help*:: + Display brief usage message and exit.
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, also implies --linear.
List dependent packages once. Implies --linear.
+*-c, \--color*:: + Use color in the output. This is done using escape codes that + should be understood by most terminal emulators. + +*\--config <file>*:: + Specify an alternate configuration file.
Specify an alternative pacman configuration file. You are missing -b,--dbpath too.
+See Also +-------- +linkman:pacman[8], linkman:pacman.conf[5], linkman:makepkg[8] + +include::footer.txt[]