[netcdf4-python] 01/02: Add missing manpages

[Ross Gammon]

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

ross-guest pushed a commit to branch master
in repository netcdf4-python.

commit a9fd99e062d2e32793a1b7229b6aa18289f3d2df
Author: Ross Gammon <rossgammon at mail.dk>
Date:   Mon Mar 23 18:17:36 2015 +0100

    Add missing manpages
---
 debian/nc3tonc4.1 | 78 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 debian/nc4tonc3.1 | 45 ++++++++++++++++++++++++++++++++
 debian/ncinfo.1   | 44 +++++++++++++++++++++++++++++++
 3 files changed, 167 insertions(+)

diff --git a/debian/nc3tonc4.1 b/debian/nc3tonc4.1
new file mode 100644
index 0000000..e6a3de5
--- /dev/null
+++ b/debian/nc3tonc4.1
@@ -0,0 +1,78 @@
+.\" (C) Copyright 2015, Ross Gammon <rossgammon at mail.dk>,
+.\"
+.TH NC3TONC4 1 "22 Mar 2015"
+.\"
+.SH NAME
+nc3tonc4 \- a program to convert netCDF 3 files to netCDF 4 format files
+.SH SYNOPSIS
+.B nc3tonc4
+.RB [\-h ]
+.RB [\-o ]
+.RB [\-\-vars=\fIvar1,var2,..\fR ]
+.RB [\-\-zlib=\fI(0|1)\fR ]
+.RB [\-\-complevel=\fI(1\-9)\fR ]
+.RB [\-\-shuffle=\fI(0|1)\fR ]
+.RB [\-\-fletcher32=\fI(0|1)\fR ]
+.RB [\-\-unpackshort=\fI(0|1)\fR ]
+.RB [\-\-quantize=\fIvar1=n1,var2=n2,..\fR ]
+.I netcdf3filename
+.I netcdf4filename
+.br
+.SH DESCRIPTION
+This manual page documents briefly the
+.B nc3tonc4
+command.
+.PP
+\fBnc3tonc4\fP is a program that converts a netCDF 3 file into netCDF 4 format, optionally unpacking variables packed as short integers (with scale_factor and add_offset) to floats, and adding zlib compression (with the HDF5 shuffle filter and fletcher32 checksum). Data may also be quantized (truncated) to a specified precision to improve compression.
+.SH OPTIONS
+These programs follow the usual GNU command line syntax, with long
+options starting with two dashes (`-').
+A summary of options is included below.
+.TP
+.B \-h
+Shows a summary of the available options.
+.TP
+.B \-o
+Overwite destination file (default is to raise an error if output file already exists).
+.TP
+.B \-\-vars
+A comma separated list of variable names to copy (default is to copy all variables).
+.TP
+.B \-\-classic=(0|1)
+Use NETCDF4_CLASSIC format instead of NETCDF4 (default = 1).
+.TP
+.B \-\-zlib=(0|1)
+Activate (or disable) zlib compression (the default is to activate).
+.TP
+.B \-\-complevel=(1-9)
+Set the zlib compression level (6 is default).
+.TP
+.B \-\-shuffle=(0|1)
+Activate (or disable) the shuffle filter (it is active by default).
+.TP
+.B \-\-fletcher32=(0|1)
+Activate (or disable) the fletcher32 checksum (it is not active by default).
+.TP
+.B \-\-unpackshort=(0|1)
+Unpack short integer variables to float variables using scale_factor and add_offset netCDF variable attributes (it is active by default).
+.TP
+.B \-\-quantize=(comma separated list of "variable name=integer" pairs)
+Truncate the data in the specified variables to a given decimal precision. For example, 'speed=2, height=-2, temp=0' will cause the variable 'speed' to be truncated to a precision of 0.01, 'height' to a precision of 100 and 'temp' to 1. This can significantly improve compression. The default is not to quantize any of the variables.
+.TP
+.B \-\-quiet=(0|1)
+If set to 1, don't print any diagnostic information.
+.TP
+.B \-\-chunk=(integer)
+The number of records along unlimited dimension to write at once. The default is 10. It is ignored if there is no unlimited dimension. If chunk=0, it means write all the data at once.
+.TP
+.B \-\-istart=(integer)
+The number of the record to start at along unlimited dimension. The default is 0. This option is ignored if there is no unlimited dimension.
+.TP
+.B \-\-istop=(integer)
+The number of the record to stop at along unlimited dimension. The default is 1. This option is ignored if there is no unlimited dimension.
+.SH SEE ALSO
+.BR ncinfo (1),
+.BR nc4tonc3 (1).
+.br
+.SH AUTHOR
+This manual page was written by Ross Gammon <rossgammon at mail.dk> based on the options displayed by nc3tonc4 \-h.
diff --git a/debian/nc4tonc3.1 b/debian/nc4tonc3.1
new file mode 100644
index 0000000..671f582
--- /dev/null
+++ b/debian/nc4tonc3.1
@@ -0,0 +1,45 @@
+.\" (C) Copyright 2015, Ross Gammon <rossgammon at mail.dk>,
+.\"
+.TH NC4TONC3 1 "22 Mar 2015"
+.\"
+.SH NAME
+nc4tonc3 \- a program to convert a classic netCDF 4 file to netCDF 3 format
+.SH SYNOPSIS
+.B nc4tonc3
+.RB [\-h ]
+.RB [\-o ]
+.RB [\-\-chunk]
+.I netcdf4filename
+.I netcdf3filename
+.br
+.SH DESCRIPTION
+This manual page documents briefly the
+.B nc4tonc3
+command.
+.PP
+\fBnc4tonc3\fP is a program that converts a netCDF 4 file (in NETCDF4_CLASSIC format) to netCDF 3 format.
+.SH OPTIONS
+These programs follow the usual GNU command line syntax, with long
+options starting with two dashes (`-').
+A summary of options is included below.
+.TP
+.B \-h
+Shows a summary of the available options.
+.TP
+.B \-o
+Overwite destination file (default is to raise an error if output file already exists).
+.TP
+.B \-\-quiet=(0|1)
+If set to 1, don't print any diagnostic information.
+.TP
+.B \-\-format
+Choose the netcdf3 format to use. NETCDF3_64BIT is used by default, or it can be set to NETCDF3_CLASSIC.
+.TP
+.B \-\-chunk=(integer)
+The number of records along unlimited dimension to write at once. The default is 10. It is ignored if there is no unlimited dimension. If chunk=0, this means write all the data at once.
+.SH SEE ALSO
+.BR ncinfo (1),
+.BR nc3tonc4 (1).
+.br
+.SH AUTHOR
+This manual page was written by Ross Gammon <rossgammon at mail.dk> based on the options displayed by nc3tonc4 \-h.
diff --git a/debian/ncinfo.1 b/debian/ncinfo.1
new file mode 100644
index 0000000..c219e82
--- /dev/null
+++ b/debian/ncinfo.1
@@ -0,0 +1,44 @@
+.\" (C) Copyright 2015, Ross Gammon <rossgammon at mail.dk>,
+.\"
+.TH NCINFO 1 "22 Mar 2015"
+.\"
+.SH NAME
+ncinfo \- a program to print summary information about a netCDF file
+.SH SYNOPSIS
+.B ncinfo
+.RB [ \-h ]
+.RB [ \-g|\-\-group=\fIgrp\fR ]
+.RB [ \-v|\-\-variable=\fIvar\fR ]
+.RB [ \-d|\-\-dimension=\fIdim\fR ]
+.I filename
+.br
+.SH DESCRIPTION
+This manual page documents briefly the
+.B ncinfo
+command.
+.PP
+\fBncinfo\fP is a program that prints summary information about a netCDF file
+.SH OPTIONS
+These programs follow the usual GNU command line syntax, with long
+options starting with two dashes (`-').
+A summary of options is included below.
+.TP
+.B \-h
+Shows a summary of the available options.
+.TP
+.B \-g grp, \-\-group=grp
+Prints information for this group. The default group is the root group. Nested groups are specified using posix paths e.g. group1/group2/group3.
+.TP
+.B \-v <variable name>, \-\-variable=<variable name>
+Prints information for this variable.
+.TP
+.B \-d <dimension name>, \-\-dimension=<dimension name>
+Prints information for this dimension.
+.TP
+The filename of the netCDF file must be supplied as the last argument.
+.SH SEE ALSO
+.BR nc3tonc4 (1),
+.BR nc4tonc3 (1).
+.br
+.SH AUTHOR
+This manual page was written by Ross Gammon <rossgammon at mail.dk> based on the options displayed by ncinfo \-h.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-grass/netcdf4-python.git