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

[Nilesh Patra]

Nilesh Patra pushed to branch master at Debian Med / vcfanno


Commits:
4aa98312 by Nilesh Patra at 2020-07-18T02:57:38+05:30
Add manpage

- - - - -
66d4559a by Nilesh Patra at 2020-07-18T02:58:03+05:30
Change arch of examples package to all

- - - - -


4 changed files:

- debian/control
- + debian/createmanpages
- + debian/manpages
- + debian/vcfanno.1


Changes:

=====================================
debian/control
=====================================
@@ -46,10 +46,9 @@ Description: annotate a VCF with other VCFs/BEDs/tabixed files
  second using 12 processes on a server.
 
 Package: vcfanno-examples
-Architecture: any
+Architecture: all
 Depends: ${shlibs:Depends},
          ${misc:Depends}
-Built-Using: ${misc:Built-Using}
 Description: examples for vcfanno: annotate a VCF with other VCFs/BEDs/tabixed files
  Vcfanno allows you to quickly annotate your VCF with any number of INFO
  fields from any number of VCFs or BED files. It uses a simple conf file


=====================================
debian/createmanpages
=====================================
@@ -0,0 +1,29 @@
+#!/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=vcfanno
+help2man --no-info --no-discard-stderr --help-option="-h" \
+         --name="$NAME" \
+            --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


=====================================
debian/vcfanno.1
=====================================
@@ -0,0 +1,34 @@
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.12.
+.TH VCFANNO "1" "July 2020" "vcfanno 0.3.2+ds" "User Commands"
+.SH NAME
+vcfanno \- annotate a VCF with other VCFs/BEDs/tabixed files
+.SH DESCRIPTION
+=============================================
+vcfanno version 0.3.2 [built with go1.14.4]
+.PP
+see: https://github.com/brentp/vcfanno
+=============================================
+Usage of vcfanno:
+.HP
+\fB\-base\-path\fR string
+.IP
+optional base\-path to prepend to annotation files in the config
+.HP
+\fB\-ends\fR
+.IP
+annotate the start and end as well as the interval itself.
+.HP
+\fB\-lua\fR string
+.IP
+optional path to a file containing custom javascript functions to be used as ops
+.HP
+\fB\-p\fR int
+.IP
+number of processes to use. (default 2)
+.HP
+\fB\-permissive\-overlap\fR
+.IP
+annotate with an overlapping variant even it doesn't share the same ref and alt alleles. Default is to require exact match between variants.
+.SH AUTHOR
+ This manpage was written by Nilesh Patra for the Debian distribution and
+ can be used for any other usage of the program.



View it on GitLab: https://salsa.debian.org/med-team/vcfanno/-/compare/199741cc61fada0e121c6cb8b921f3b3529a27f0...66d4559a8b8a396d04f9bfb6be6a3bc6ea4c77d1

-- 
View it on GitLab: https://salsa.debian.org/med-team/vcfanno/-/compare/199741cc61fada0e121c6cb8b921f3b3529a27f0...66d4559a8b8a396d04f9bfb6be6a3bc6ea4c77d1
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/20200717/2cb9275b/attachment-0001.html>