Thanks for your contribution. Yes, I hope you will write
man pages for NCO like the one you have started.
I think we should have a manpage for each operator and one for
the whole of nco. Your template for the nco man page is a
good starting point. Look at the ncks page below for some
suggested mods--mainly get rid of version specific information,
also add ncra, ncrcat, ncea to the operator list.
I want the operator-specific man pages to have details about
the command line switches to the operator, possibly one or
two examples, and then a pointer to the info manual/website.
The SYNOPSIS and OPTIONS can be copied directly from the
terminal ouput of the operators themselves (e.g., I just
typed ncks and hit return for the example below).
Here's a quick example for ncks. It would be great
if you would polish this, maybe add an example, and post it
to the developer's forum on sourceforge.net. Let's continue
this discussion there so that others can contribute ideas.
Once we've iterated a few time to get an acceptable ncks and nco
man page, the others should be easy to crank out and we can add
them to the source tree.
-A Append to existing output file, if any
-a Disable alphabetization of extracted variables
-c Coordinate variables will all be processed
-C Associated coordinate variables should not be processed
-D dbg_lvl Debugging level
-d dim,[min][,[max]][,[stride]] Dimension's limits and stride in hyperslab
-F Fortran indexing conventions (1-based) for I/O
-H Print data
-l path Local storage path for remotely-retrieved files
-m Print variable metadata
-O Overwrite existing output file, if any
-p path Path prefix for all input filenames
-q Toggle printing of dimension indices and coordinate values
-R Retain remotely-retrieved files after use
-r Program version and copyright notice
-s format String format for text output
-u Units of variables, if any, will be printed
-v var1[,var2[...]] Variables to process
-x Extract all variables EXCEPT those specified with -v
in.nc Input file name(s)
out.nc Output file name
AUTHOR
Charlie Zender with help from others.
See the manual under 'Contributing' for a full list of contributors.
COPYRIGHT
Copyright (C) 1995--2001 Charlie Zender.
NCO is free software and comes with ABSOLUTELY NO WARRANTY NCO is
distributed under the terms of the GNU General Public License.
The full documentation for the NCO package is main-
tained as a Texinfo manual. If the info and NCO pro-
grams are properly installed at your site, the command
info nco
should give you access to the complete manual.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Hello Roelof,
Thanks for your contribution. Yes, I hope you will write
man pages for NCO like the one you have started.
I think we should have a manpage for each operator and one for
the whole of nco. Your template for the nco man page is a
good starting point. Look at the ncks page below for some
suggested mods--mainly get rid of version specific information,
also add ncra, ncrcat, ncea to the operator list.
I want the operator-specific man pages to have details about
the command line switches to the operator, possibly one or
two examples, and then a pointer to the info manual/website.
The SYNOPSIS and OPTIONS can be copied directly from the
terminal ouput of the operators themselves (e.g., I just
typed ncks and hit return for the example below).
Here's a quick example for ncks. It would be great
if you would polish this, maybe add an example, and post it
to the developer's forum on sourceforge.net. Let's continue
this discussion there so that others can contribute ideas.
https://sourceforge.net/forum/forum.php?forum_id=9831
Once we've iterated a few time to get an acceptable ncks and nco
man page, the others should be easy to crank out and we can add
them to the source tree.
Thanks,
Charlie
NAME ncks netCDF Kitchen Sink
SYNOPSIS ncks [-A] [-a] [-C] [-c] [-D dbg_lvl] [-d ...] [-F] [-H] [-h]
[-l path] [-m] [-O] [-p path] [-q] [-R] [-r] [-s format] [-u] [-v ...]
[-x] in.nc [out.nc]
DESCRIPTION
ncks is blah blah blah.
OPTIONS
Command line switches:
-A Append to existing output file, if any
-a Disable alphabetization of extracted variables
-c Coordinate variables will all be processed
-C Associated coordinate variables should not be processed
-D dbg_lvl Debugging level
-d dim,[min][,[max]][,[stride]] Dimension's limits and stride in hyperslab
-F Fortran indexing conventions (1-based) for I/O
-H Print data
-l path Local storage path for remotely-retrieved files
-m Print variable metadata
-O Overwrite existing output file, if any
-p path Path prefix for all input filenames
-q Toggle printing of dimension indices and coordinate values
-R Retain remotely-retrieved files after use
-r Program version and copyright notice
-s format String format for text output
-u Units of variables, if any, will be printed
-v var1[,var2[...]] Variables to process
-x Extract all variables EXCEPT those specified with -v
in.nc Input file name(s)
out.nc Output file name
AUTHOR
Charlie Zender with help from others.
See the manual under 'Contributing' for a full list of contributors.
COPYRIGHT
Copyright (C) 1995--2001 Charlie Zender.
NCO is free software and comes with ABSOLUTELY NO WARRANTY NCO is
distributed under the terms of the GNU General Public License.
SEE ALSO
NCO homepage at http://nco.sourceforge.net has complete
online User's Guide Post questions, suggestions, patches
at http://sourceforge.net/projects/nco
The full documentation for the NCO package is main-
tained as a Texinfo manual. If the info and NCO pro-
grams are properly installed at your site, the command
info nco
should give you access to the complete manual.