[pytables] 19/20: New manpage for the pttree utility

[Antonio Valentino]

This is an automated email from the git hooks/post-receive script.

a_valentino-guest pushed a commit to branch master
in repository pytables.

commit 02ebcb2e677f5a48bf3ba9d7f146709824256c39
Author: Antonio Valentino <antonio.valentino at tiscali.it>
Date:   Fri Aug 14 17:16:15 2015 +0000

    New manpage for the pttree utility
---
 debian/changelog              |  1 +
 debian/pttree.1               | 79 +++++++++++++++++++++++++++++++++++++++++++
 debian/python-tables.manpages |  1 +
 3 files changed, 81 insertions(+)

diff --git a/debian/changelog b/debian/changelog
index cd65f52..281a00b 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -25,6 +25,7 @@ pytables (3.2.1-1) UNRELEASED; urgency=medium
       The issue with lz4 compressor on s39x has been fixed in lz4_0.0~r122-1.
   * README.txt has been renamed into README.rst upsream.
      Updated python-pytables*.docs files.
+  * New manpage for the pttree utility
 
  -- Antonio Valentino <antonio.valentino at tiscali.it>  Sun, 22 Mar 2015 18:43:52 +0000
 
diff --git a/debian/pttree.1 b/debian/pttree.1
new file mode 100644
index 0000000..04bdb6d
--- /dev/null
+++ b/debian/pttree.1
@@ -0,0 +1,79 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH pttree 1 "May 15, 2013"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh        disable hyphenation
+.\" .hy        enable hyphenation
+.\" .ad l      left justify
+.\" .ad b      justify to both left and right margins
+.\" .nf        disable filling
+.\" .fi        enable filling
+.\" .br        insert line break
+.\" .sp <n>    insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+pttree \- prints a quick overview of the contents of PyTables HDF5 files.
+.SH SYNOPSIS
+.B pttree
+[ OPTIONS ]
+.RB filename[:nodepath]
+.br
+.SH DESCRIPTION
+.B pttree
+is designed to give a quick overview of the contents of a PyTables
+HDF5 file by printing a depth-indented list of nodes, similar to the output of
+the Unix `tree` function. It can also display the size, shape and compression
+states of individual nodes, as well as summary information for the whole file.
+For a more verbose output (including metadata), see `ptdump`.
+
+.SH OPTIONS
+A summary of options is included below.
+.TP
+.B \-L MAX_DEPTH, \--max-level MAX_DEPTH
+maximum branch depth of tree to display (-1 == no limit)
+.TP
+.B \-S SORT_BY, \--sort-by SORT_BY
+artificially order nodes, can be either "size", "name" or "none"
+.TP
+.B \--print-size
+print size of each node/branch
+.TP
+.B \--no-print-size
+.TP
+.B \--print-shape
+print shape of each node
+.TP
+.B \--no-print-shape
+.TP
+.B \--print-compression
+print compression library(level) for each compressed node
+.TP
+.B \--no-print-compression
+.TP
+.B \--print-percent
+print size of each node as a % of the total tree size on disk
+.TP
+.B \--no-print-percent
+.TP
+.B \--use-si-units
+report sizes in SI units (1 MB == 10^6 B)
+.TP
+.B \--use-binary-units
+report sizes in binary units (1 MiB == 2^20 B)
+.TP
+.B \-h
+Print help on usage.
+
+.br
+
+.SH SEE ALSO
+.BR ptdump (1).
+.br
+These utilities are documented fully by
+.IR "PyTables user's manual".
+.SH AUTHOR
+This manual page was written by Antonio Valentino <antonio.valentino at tiscali.it>.
diff --git a/debian/python-tables.manpages b/debian/python-tables.manpages
index 1f3d1a0..06b15b1 100644
--- a/debian/python-tables.manpages
+++ b/debian/python-tables.manpages
@@ -2,3 +2,4 @@ debian/nctoh5.1
 debian/ptdump.1
 debian/ptrepack.1
 debian/pt2to3.1
+debian/pttree.1

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/pytables.git