[cdftools] 03/10: more manpage work
Alastair McKinstry
mckinstry at moszumanska.debian.org
Sat Jul 29 10:16:25 UTC 2017
This is an automated email from the git hooks/post-receive script.
mckinstry pushed a commit to branch debian/master
in repository cdftools.
commit e3fa151913adc850bc119f97887e67f29dfd9184
Author: Alastair McKinstry <mckinstry at debian.org>
Date: Wed Jul 19 12:12:03 2017 +0100
more manpage work
---
debian/manpages/cdf2matlab.1 | 5 ++++
debian/manpages/cdfbti.1 | 71 +++++++++++++++++++++++++-------------------
2 files changed, 46 insertions(+), 30 deletions(-)
diff --git a/debian/manpages/cdf2matlab.1 b/debian/manpages/cdf2matlab.1
index 040464b..e5830c6 100644
--- a/debian/manpages/cdf2matlab.1
+++ b/debian/manpages/cdf2matlab.1
@@ -6,6 +6,11 @@ cdf2matlab \- Convert NEMO input file to a file with monotonically increasing l
.SH SYNOPSIS
cdf2matlab IN-file IN-var level
+.SH INPUT
+IN-file \- input model file
+
+IN-var \- netcdf variable name to process.
+
.SH REQUIRED FILES
None.
diff --git a/debian/manpages/cdfbti.1 b/debian/manpages/cdfbti.1
index e7d63d5..ed9db80 100644
--- a/debian/manpages/cdfbti.1
+++ b/debian/manpages/cdfbti.1
@@ -3,38 +3,49 @@
.SH NAME
cdfbti \- Compute the terms in the barotropic energy transfer equation
+.SH SYNOPSIS
+cdfbti \fBUVWT-file\fR
+
+.SH PURPOSE
+Compute the terms in the barotropic energy tranfer equation.
+The transfert of energy for the barotropic instability is
+bti= -[(u''bar)^2*dubar/dx ...
+ +(v''bar)^2*dvbar/dy ...
+ +(u''v''*(dubar/dy +dvbar/dx))]
+
+.SH INPUT
+UVWT-file : netcdf file produced by \fBcdfmoyuvwt\fR
+
+.SH OUTOUT
+.TP
+netcdf file: \fBcf_out\fR
+.TP
+variables:
+.TP
+dudx : zonal derivate of ubar on T point
+.TP
+dvdx : zonal derivate of vbar on T point
+.TP
+dudy : meridional derivate of ubar on T point
+.TP
+dvdy : meridional derivate of vbar on T point
+.TP
+anousqrt : mean of (u-ubar)^2 on T point
+.TP
+anovsqrt : mean of (v-vbar)^2 on T point
+.TP
+anouv : mean of (u-ubar)*(v-vbar) on T point
+.TP
+bti : transfert of energy for the barotropic instability.
+
+.SH REQUIRED FILES
+cn_fhgr
+
.SH SEE ALSO
cdfmoyuvwt(1), cdfbci(1),
cdfnrjcomp(1), cdfkempemekeepe(1)
-.\" *,' usage : cdfbti UVWT-file'
-.\" *,' '
-.\" *,' PURPOSE :'
-.\" *,' Compute the terms in the barotropic energy tranfert equation.'
-.\" *,' The transfert of energy for the barotropic instability is '
-.\" *,' bti= -[(u''bar)^2*dubar/dx ...'
-.\" *,' +(v''bar)^2*dvbar/dy ...'
-.\" *,' +(u''v''*(dubar/dy +dvbar/dx))]'
-.\" *,' '
-.\" *,' ARGUMENTS :'
-.\" *,' UVWT-file : netcdf file produced by cdfmoyuvwt'
-.\" *,' '
-.\" *,' REQUIRED FILES :'
-.\" *,' ', TRIM(cn_fhgr)
-.\" *,' '
-.\" *,' OUTPUT : '
-.\" *,' netcdf file : ', TRIM(cf_out)
-.\" *,' variables : '
-.\" *,' dudx : zonal derivate of ubar on T point'
-.\" *,' dvdx : zonal derivate of vbar on T point'
-.\" *,' dudy : meridional derivate of ubar on T point'
-.\" *,' dvdy : meridional derivate of vbar on T point'
-.\" *,' anousqrt : mean of (u-ubar)^2 on T point'
-.\" *,' anovsqrt : mean of (v-vbar)^2 on T point'
-.\" *,' anouv : mean of (u-ubar)*(v-vbar) on T point'
-.\" *,' bti : transfert of energy for the barotropic instability.'
-.\" *,' '
-.\" *,' SEE ALSO :'
-.\" *,' cdfmoyuvwt, cdfbci, cdfnrjcomp, cdfkempemekeepe'
-.\" *,' '
+.SH AUTHOR
+CDFTOOLS was created by J.-M. Molines.
+This manpage was written by Alastair McKinstry
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/cdftools.git
More information about the debian-science-commits
mailing list