[med-svn] [Git][med-team/nibabel][master] Add manpages
Nilesh Patra
gitlab at salsa.debian.org
Mon Jul 27 15:27:45 BST 2020
Nilesh Patra pushed to branch master at Debian Med / nibabel
Commits:
669d0cbe by Nilesh Patra at 2020-07-27T14:27:28+00:00
Add manpages
- - - - -
6 changed files:
- + debian/createmanpages
- + debian/manpages
- + debian/nib-conform.1
- + debian/nib-diff.1
- + debian/nib-tck2trk.1
- + debian/nib-trk2tck.1
Changes:
=====================================
debian/createmanpages
=====================================
@@ -0,0 +1,76 @@
+#!/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=nib-conform
+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
+
+# If program name is different from package name or title should be
+# different from package short description change this here
+progname=nib-diff
+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
+
+# If program name is different from package name or title should be
+# different from package short description change this here
+progname=nib-tck2trk
+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
+
+# If program name is different from package name or title should be
+# different from package short description change this here
+progname=nib-trk2tck
+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/nib-conform.1
=====================================
@@ -0,0 +1,41 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.12.
+.TH NIB-CONFORM "1" "July 2020" "nib-conform 3.1.1" "User Commands"
+.SH NAME
+nib-conform \- Python3 bindings to various neuroimaging data formats
+.SH DESCRIPTION
+usage: nib\-conform [\-h] [\-\-out\-shape OUT_SHAPE OUT_SHAPE OUT_SHAPE]
+.IP
+[\-\-voxel\-size VOXEL_SIZE VOXEL_SIZE VOXEL_SIZE]
+[\-\-orientation ORIENTATION] [\-f] [\-V]
+infile outfile
+.PP
+Conform neuroimaging volume to arbitrary shape and voxel size.
+.SS "positional arguments:"
+.TP
+infile
+Neuroimaging volume to conform.
+.TP
+outfile
+Name of output file.
+.SS "optional arguments:"
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+show this help message and exit
+.TP
+\fB\-\-out\-shape\fR OUT_SHAPE OUT_SHAPE OUT_SHAPE
+Shape of the conformed output.
+.TP
+\fB\-\-voxel\-size\fR VOXEL_SIZE VOXEL_SIZE VOXEL_SIZE
+Voxel size in millimeters of the conformed output.
+.TP
+\fB\-\-orientation\fR ORIENTATION
+Orientation of the conformed output.
+.TP
+\fB\-f\fR, \fB\-\-force\fR
+Overwrite existing output files.
+.TP
+\fB\-V\fR, \fB\-\-version\fR
+show program's version number and exit
+.SH AUTHOR
+ This manpage was written by Nilesh Patra for the Debian distribution and
+ can be used for any other usage of the program.
=====================================
debian/nib-diff.1
=====================================
@@ -0,0 +1,46 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.12.
+.TH NIB-DIFF "1" "July 2020" "nib-diff 3.1.1" "User Commands"
+.SH NAME
+nib-diff \- Python3 bindings to various neuroimaging data formats
+.SH SYNOPSIS
+.B nib-diff
+[\fI\,OPTIONS\/\fR] [\fI\,FILE \/\fR...]
+.SH DESCRIPTION
+Quick summary of the differences among a set of neuroimaging files
+.SS "Notes:"
+.IP
+\- difference in data types for header fields will be detected, but
+.IP
+endianness difference will not be detected. It is done so to compare files
+with native endianness used in data files.
+.SH OPTIONS
+.TP
+\fB\-\-version\fR
+show program's version number and exit
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+show this help message and exit
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Make more noise. Could be specified multiple times
+.TP
+\fB\-H\fR HEADER_FIELDS, \fB\-\-header\-fields\fR=\fI\,HEADER_FIELDS\/\fR
+Header fields (comma separated) to be printed as well
+(if present)
+.TP
+\fB\-\-ma\fR=\fI\,DATA_MAX_ABS_DIFF\/\fR, \fB\-\-data\-max\-abs\-diff\fR=\fI\,DATA_MAX_ABS_DIFF\/\fR
+Maximal absolute difference in data between files to
+tolerate.
+.TP
+\fB\-\-mr\fR=\fI\,DATA_MAX_REL_DIFF\/\fR, \fB\-\-data\-max\-rel\-diff\fR=\fI\,DATA_MAX_REL_DIFF\/\fR
+Maximal relative difference in data between files to
+tolerate. If \fB\-\-data\-max\-abs\-diff\fR is also specified,
+only the data points with absolute difference greater
+than that value would be considered for relative
+difference check.
+.TP
+\fB\-\-dt\fR=\fI\,DTYPE\/\fR, \fB\-\-datatype\fR=\fI\,DTYPE\/\fR
+Enter a numpy datatype such as 'float32'.
+.SH AUTHOR
+ This manpage was written by Nilesh Patra for the Debian distribution and
+ can be used for any other usage of the program.
=====================================
debian/nib-tck2trk.1
=====================================
@@ -0,0 +1,25 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.12.
+.TH NIB-TCK2TRK "1" "July 2020" "nib-tck2trk 3.1.1" "User Commands"
+.SH NAME
+nib-tck2trk \- Python3 bindings to various neuroimaging data formats
+.SH DESCRIPTION
+usage: nib\-tck2trk [\-h] [\-f] anatomy tractogram [tractogram ...]
+.PP
+Convert tractograms (TCK \-> TRK).
+.SS "positional arguments:"
+.TP
+anatomy
+reference anatomical image (.nii|.nii.gz.
+.TP
+tractogram
+list of tractograms (.tck).
+.SS "optional arguments:"
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+show this help message and exit
+.TP
+\fB\-f\fR, \fB\-\-force\fR
+overwrite existing output files.
+.SH AUTHOR
+ This manpage was written by Nilesh Patra for the Debian distribution and
+ can be used for any other usage of the program.
=====================================
debian/nib-trk2tck.1
=====================================
@@ -0,0 +1,22 @@
+.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.47.12.
+.TH NIB-TRK2TCK "1" "July 2020" "nib-trk2tck 3.1.1" "User Commands"
+.SH NAME
+nib-trk2tck \- Python3 bindings to various neuroimaging data formats
+.SH DESCRIPTION
+usage: nib\-trk2tck [\-h] [\-f] tractogram [tractogram ...]
+.PP
+Convert tractograms (TRK \-> TCK).
+.SS "positional arguments:"
+.TP
+tractogram
+list of tractograms (.trk).
+.SS "optional arguments:"
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+show this help message and exit
+.TP
+\fB\-f\fR, \fB\-\-force\fR
+overwrite existing output files.
+.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/nibabel/-/commit/669d0cbed937db2bae004a4dda09b03cca2b734c
--
View it on GitLab: https://salsa.debian.org/med-team/nibabel/-/commit/669d0cbed937db2bae004a4dda09b03cca2b734c
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/20200727/413648fc/attachment-0001.html>
More information about the debian-med-commit
mailing list