[med-svn] [Git][med-team/python-cooler][master] 2 commits: Add manpage

[Andreas Tille]

Andreas Tille pushed to branch master at Debian Med / python-cooler


Commits:
4e831d4a by Andreas Tille at 2020-06-14T21:29:47+02:00
Add manpage

- - - - -
b205be49 by Andreas Tille at 2020-06-14T22:50:11+02:00
ITP bug

- - - - -


4 changed files:

- debian/changelog
- + debian/cooler.1
- + debian/createmanpages
- + debian/manpages


Changes:

=====================================
debian/changelog
=====================================
@@ -1,5 +1,5 @@
 python-cooler (0.8.7-1) UNRELEASED; urgency=medium
 
-  * Initial release (Closes: #<bug>)
+  * Initial release (Closes: #962792)
 
  -- Andreas Tille <tille at debian.org>  Sat, 13 Jun 2020 15:48:26 +0200


=====================================
debian/cooler.1
=====================================
@@ -0,0 +1,87 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.15.
+.TH COOLER "1" "June 2020" "cooler 0.8.7" "User Commands"
+.SH NAME
+cooler \- sparse, compressed, binary persistent storage
+.SH SYNOPSIS
+.B cooler
+[\fI\,OPTIONS\/\fR] \fI\,COMMAND \/\fR[\fI\,ARGS\/\fR]...
+.SH DESCRIPTION
+Cooler is a support library for a sparse, compressed, binary persistent
+storage format, also called cooler, used to store genomic interaction
+data, such as Hi-C contact matrices.
+.P
+The cooler file format is an implementation of a genomic matrix data
+model using HDF5 as the container format. The cooler package includes a
+suite of command line tools and a Python API to facilitate creating,
+querying and manipulating cooler files.
+.SH OPTIONS
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Verbose logging.
+.TP
+\fB\-d\fR, \fB\-\-debug\fR
+On error, drop into the post\-mortem debugger shell.
+.TP
+\fB\-V\fR, \fB\-\-version\fR
+Show the version and exit.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Show this message and exit.
+.SS "Commands:"
+.TP
+cload
+Create a cooler from genomic pairs and bins.
+.TP
+load
+Create a cooler from a pre\-binned matrix.
+.TP
+merge
+Merge multiple coolers with identical axes.
+.TP
+coarsen
+Coarsen a cooler to a lower resolution.
+.TP
+zoomify
+Generate a multi\-resolution cooler file by coarsening.
+.TP
+balance
+Out\-of\-core matrix balancing.
+.TP
+info
+Display a cooler's info and metadata.
+.TP
+dump
+Dump a cooler's data to a text stream.
+.TP
+show
+Display and browse a cooler in matplotlib.
+.TP
+makebins
+Generate fixed\-width genomic bins.
+.TP
+digest
+Generate fragment\-delimited genomic bins.
+.TP
+csort
+Sort and index a contact list.
+.TP
+ls
+List all coolers inside a file.
+.TP
+cp
+Copy a cooler from one file to another or within the same file.
+.TP
+ln
+Create a hard link to a cooler (rather than a true copy) in the...
+.TP
+mv
+Rename a cooler within the same file.
+.TP
+tree
+Display a file's data hierarchy.
+.TP
+attrs
+Display a file's attribute hierarchy.
+.SH AUTHOR
+ This manpage was written by Andreas Tille for the Debian distribution and
+ can be used for any other usage of the program.


=====================================
debian/createmanpages
=====================================
@@ -0,0 +1,28 @@
+#!/bin/sh
+MANDIR=debian
+mkdir -p $MANDIR
+
+VERSION=`dpkg-parsechangelog | awk '/^Version:/ {print $2}' | sed -e 's/^[0-9]*://' -e 's/-.*//' -e 's/[+~]dfsg$//'`
+NAME=`grep "^Description:" debian/control | sed 's/^Description: *//' | head -n1`
+PROGNAME=`grep "^Package:" debian/control | sed 's/^Package: *//' | head -n1`
+
+AUTHOR=".SH AUTHOR\n \
+This manpage was written by $DEBFULLNAME for the Debian distribution and\n \
+can be used for any other usage of the program.\
+"
+
+# If program name is different from package name or title should be
+# different from package short description change this here
+progname=cooler
+help2man --no-info --no-discard-stderr --help-option=" --help" \
+         --name="sparse, compressed, binary persistent storage" \
+            --version-string="$VERSION" ${progname} > $MANDIR/${progname}.1
+echo $AUTHOR >> $MANDIR/${progname}.1
+
+echo "$MANDIR/*.1" > debian/manpages
+
+cat <<EOT
+Please enhance the help2man output.
+The following web page might be helpful in doing so:
+    http://liw.fi/manpages/
+EOT


=====================================
debian/manpages
=====================================
@@ -0,0 +1 @@
+debian/*.1



View it on GitLab: https://salsa.debian.org/med-team/python-cooler/-/compare/c67c084b1db739f71f34db017a8c15dc045c8170...b205be4903bffa79826a6db7b7d74f4cd109320a

-- 
View it on GitLab: https://salsa.debian.org/med-team/python-cooler/-/compare/c67c084b1db739f71f34db017a8c15dc045c8170...b205be4903bffa79826a6db7b7d74f4cd109320a
You're receiving this email because of your account on salsa.debian.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://alioth-lists.debian.net/pipermail/debian-med-commit/attachments/20200614/e895c0c8/attachment-0001.html>