commit 3e5cafe5491c3185340ea0613b4b3a6e36629bdf
parent fd09ea6165b3b3aeac5992cbf9cd89f85157abb0
Author: Vincent Forest <vincent.forest@meso-star.com>
Date: Sat, 22 Oct 2022 08:31:32 +0200
Update the les2htcp man page
Diffstat:
1 file changed, 24 insertions(+), 24 deletions(-)
diff --git a/doc/les2htcp.1.scd b/doc/les2htcp.1.scd
@@ -1,7 +1,7 @@
les2htcp(1)
; Copyright (C) 2018, 2020-2022 |Méso|Star> (contact@meso-star.com)
-; Copyright (C) 2018 CNRS
+; Copyright (C) 2018 Centre National de la Recherche Scientifique
; Copyright (C) 2018 Université Paul Sabatier (contact-edstar@laplace.univ-tlse.fr)
;
; This program is free software: you can redistribute it and/or modify
@@ -51,37 +51,37 @@ file [1]. Expected variables in the submitted NetCDF file are:
# OPTIONS
-*-c*++
+*-c*
Advanced checks on the validity of the submitted _NetCDF_ file with respect
-to the *les2htcp* prerequisites on the NetCDF data. Note that this option
-can increase significantly the conversion time.
+ to the *les2htcp* prerequisites on the NetCDF data. Note that this option
+ can increase significantly the conversion time.
-*-f*++
+*-f*
Force overwrite of the _output_ file.
-*-h*++
+*-h*
List short help and exit.
-*-i* _NetCDF_++
+*-i* _NetCDF_
NetCDF file to convert.
-*-m* _float-to-meter_++
+*-m* _float-to-meter_
Scale factor from floating point unit to meters. By default it is set to 1.
-*-o* _output_++
+*-o* _output_
Destination file where the *htcp*(5) file is written. If not defined, the
-results are written to standard output.
+ results are written to standard output.
-*-p* _page-size_++
+*-p* _page-size_
Targeted page size in bytes; must be a power of 2. The size of the converted
-NetCDF data and their starting address into the *htcp*(5) file are aligned
-according to _page-size_. By default, _page-size_ is 4096 bytes.
+ NetCDF data and their starting address into the *htcp*(5) file are aligned
+ according to _page-size_. By default, _page-size_ is 4096 bytes.
-*-q*++
+*-q*
Write nothing to _output_. Might be used in conjunction of the *-c* option
-to only check the submitted _NetCDF_.
+ to only check the submitted _NetCDF_.
-*-v*++
+*-v*
Display version information and exit.
# EXAMPLES
@@ -97,7 +97,7 @@ les2htcp -i clouds.nc -o clouds.htcp
Convert the _clouds_km.nc_ file to *htcp*(5) file format. Use the *-f* option
to write the output file _clouds.htcp_ even though it already exists. The
_clouds_km.nc_ file to convert has its spatial unit in kilo-meters while the
-*htcp*(5) file formats assumes meters: use the *-m* _1000_ option to map
+*htcp*(5) file format assumes meters: use the *-m* _1000_ option to map
kilo-meters to meters:
```
@@ -112,15 +112,13 @@ output data:
les2htcp -c -i clouds.nc -q
```
-# NOTES
-
-. Network Common Data Form - <https://www.unidata.ucar.edu/software/netcdf/>
-
# COPYRIGHT
-Copyright © 2018, 2020 |Meso|Star> <contact@meso-star.com>.++
-Copyright © 2018 CNRS, Université Paul Sabatier
-<contact-edstar@laplace.univ-tlse.fr>.
+Copyright © 2018, 2020 |Méso|Star> <contact@meso-star.com>++
+Copyright © 2018 Centre National de la Recherche Scientifique++
+Copyright © 2018 Université Paul Sabatier <contact-edstar@laplace.univ-tlse.fr>
+
+# LICENSE
*les2htcp* is free software released under the GPLv3+ license: GNU GPL version
3 or later <https://gnu.org/licenses/gpl.html>. You are free to change and
@@ -128,4 +126,6 @@ redistribute it. There is NO WARRANTY, to the extent permitted by law.
# SEE ALSO
+. Network Common Data Form - <https://www.unidata.ucar.edu/software/netcdf/>
+
*htcp*(5)
