Commit 06ae7f1e authored by Uwe Schulzweida's avatar Uwe Schulzweida
Browse files

Docu update.

parent 001a981d
2017-03-24 Uwe Schulzweida
2017-04-13 Uwe Schulzweida
* using CGRIBEX library version 1.8.0
* Version 1.8.1 released
......
Attributes may be associated with each variable to specify non
CDI standard properties. CDI standard properties as code, name,
units, and missing value are directly associated with each variable by
the corresponding CDI function (e.g. {\htmlref{\tt vlistDefVarName}{vlistDefVarName}}).
the corresponding CDI function (e.g. {\htmlref{\texttt{vlistDefVarName}}{vlistDefVarName}}).
An attribute has a variable to which it is assigned, a name, a type,
a length, and a sequence of one or more values.
The attributes have to be defined after the variable is created and
......@@ -17,11 +17,11 @@ by the following predefined constants:
\vspace*{3mm}
\hspace*{8mm}\begin{minipage}{15cm}
\begin{deflist}{{\large\tt CDI\_DATATYPE\_TXT \ \ }}
\item[{\large\tt CDI\_DATATYPE\_INT16}] 16-bit integer attribute
\item[{\large\tt CDI\_DATATYPE\_INT32}] 32-bit integer attribute
\item[{\large\tt CDI\_DATATYPE\_FLT32}] 32-bit floating point attribute
\item[{\large\tt CDI\_DATATYPE\_FLT64}] 64-bit floating point attribute
\item[{\large\tt CDI\_DATATYPE\_TXT}] Text attribute
\begin{deflist}{\large\texttt{CDI\_DATATYPE\_TXT \ \ }}
\item[\large\texttt{CDI\_DATATYPE\_INT16}] 16-bit integer attribute
\item[\large\texttt{CDI\_DATATYPE\_INT32}] 32-bit integer attribute
\item[\large\texttt{CDI\_DATATYPE\_FLT32}] 32-bit floating point attribute
\item[\large\texttt{CDI\_DATATYPE\_FLT64}] 64-bit floating point attribute
\item[\large\texttt{CDI\_DATATYPE\_TXT}] Text attribute
\end{deflist}
\end{minipage}
\subsection{Get number of attributes: {\tt cdiInqNatts}}
\subsection{Get number of attributes: \texttt{cdiInqNatts}}
\index{cdiInqNatts}
\label{cdiInqNatts}
The function {\tt cdiInqNatts} gets the number of attributes assigned to this variable.
The function {\texttt{cdiInqNatts}} gets the number of attributes assigned to this variable.
\subsubsection*{Usage}
......@@ -13,23 +13,23 @@ The function {\tt cdiInqNatts} gets the number of attributes assigned to this va
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt nattsp\ }
\item[{\tt cdiID}]
CDI ID, from a previous call to {\htmlref{\tt vlistCreate}{vlistCreate}}, {\htmlref{\tt gridCreate}{gridCreate}} or {\htmlref{\tt streamInqVlist}{streamInqVlist}}.
\item[{\tt varID}]
Variable identifier, or {\tt CDI\_GLOBAL} for a global attribute.
\item[{\tt nattsp}]
\begin{deflist}{\texttt{nattsp}\ }
\item[\texttt{cdiID}]
CDI ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}}, {\htmlref{\texttt{gridCreate}}{gridCreate}} or {\htmlref{\texttt{streamInqVlist}}{streamInqVlist}}.
\item[\texttt{varID}]
Variable identifier, or {\texttt{CDI\_GLOBAL}} for a global attribute.
\item[\texttt{nattsp}]
Pointer to location for returned number of attributes.
\end{deflist}
\end{minipage}
\subsection{Get information about an attribute: {\tt cdiInqAtt}}
\subsection{Get information about an attribute: \texttt{cdiInqAtt}}
\index{cdiInqAtt}
\label{cdiInqAtt}
The function {\tt cdiInqAtt} gets information about an attribute.
The function {\texttt{cdiInqAtt}} gets information about an attribute.
\subsubsection*{Usage}
......@@ -38,31 +38,31 @@ The function {\tt cdiInqAtt} gets information about an attribute.
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt attnum\ }
\item[{\tt cdiID}]
CDI ID, from a previous call to {\htmlref{\tt vlistCreate}{vlistCreate}}, {\htmlref{\tt gridCreate}{gridCreate}} or {\htmlref{\tt streamInqVlist}{streamInqVlist}}.
\item[{\tt varID}]
Variable identifier, or {\tt CDI\_GLOBAL} for a global attribute.
\item[{\tt attnum}]
\begin{deflist}{\texttt{attnum}\ }
\item[\texttt{cdiID}]
CDI ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}}, {\htmlref{\texttt{gridCreate}}{gridCreate}} or {\htmlref{\texttt{streamInqVlist}}{streamInqVlist}}.
\item[\texttt{varID}]
Variable identifier, or {\texttt{CDI\_GLOBAL}} for a global attribute.
\item[\texttt{attnum}]
Attribute number (from 0 to natts-1).
\item[{\tt name}]
\item[\texttt{name}]
Pointer to the location for the returned attribute name. The caller must allocate space for the
returned string. The maximum possible length, in characters, of
the string is given by the predefined constant {\tt CDI\_MAX\_NAME}.
\item[{\tt typep}]
the string is given by the predefined constant {\texttt{CDI\_MAX\_NAME}}.
\item[\texttt{typep}]
Pointer to location for returned attribute type.
\item[{\tt lenp}]
\item[\texttt{lenp}]
Pointer to location for returned attribute number.
\end{deflist}
\end{minipage}
\subsection{Define an integer attribute: {\tt cdiDefAttInt}}
\subsection{Define an integer attribute: \texttt{cdiDefAttInt}}
\index{cdiDefAttInt}
\label{cdiDefAttInt}
The function {\tt cdiDefAttInt} defines an integer attribute.
The function {\texttt{cdiDefAttInt}} defines an integer attribute.
\subsubsection*{Usage}
......@@ -72,29 +72,29 @@ The function {\tt cdiDefAttInt} defines an integer attribute.
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt cdiID\ }
\item[{\tt cdiID}]
CDI ID, from a previous call to {\htmlref{\tt vlistCreate}{vlistCreate}} or {\htmlref{\tt gridCreate}{gridCreate}}.
\item[{\tt varID}]
Variable identifier, or {\tt CDI\_GLOBAL} for a global attribute.
\item[{\tt name}]
\begin{deflist}{\texttt{cdiID}\ }
\item[\texttt{cdiID}]
CDI ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}} or {\htmlref{\texttt{gridCreate}}{gridCreate}}.
\item[\texttt{varID}]
Variable identifier, or {\texttt{CDI\_GLOBAL}} for a global attribute.
\item[\texttt{name}]
Attribute name.
\item[{\tt type}]
External data type ({\tt CDI\_DATATYPE\_INT16} or {\tt CDI\_DATATYPE\_INT32}).
\item[{\tt len}]
\item[\texttt{type}]
External data type ({\texttt{CDI\_DATATYPE\_INT16}} or {\texttt{CDI\_DATATYPE\_INT32}}).
\item[\texttt{len}]
Number of values provided for the attribute.
\item[{\tt ip}]
\item[\texttt{ip}]
Pointer to one or more integer values.
\end{deflist}
\end{minipage}
\subsection{Get the value(s) of an integer attribute: {\tt cdiInqAttInt}}
\subsection{Get the value(s) of an integer attribute: \texttt{cdiInqAttInt}}
\index{cdiInqAttInt}
\label{cdiInqAttInt}
The function {\tt cdiInqAttInt} gets the values(s) of an integer attribute.
The function {\texttt{cdiInqAttInt}} gets the values(s) of an integer attribute.
\subsubsection*{Usage}
......@@ -103,27 +103,27 @@ The function {\tt cdiInqAttInt} gets the values(s) of an integer attribute.
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt cdiID\ }
\item[{\tt cdiID}]
CDI ID, from a previous call to {\htmlref{\tt vlistCreate}{vlistCreate}}, {\htmlref{\tt gridCreate}{gridCreate}} or {\htmlref{\tt streamInqVlist}{streamInqVlist}}.
\item[{\tt varID}]
Variable identifier, or {\tt CDI\_GLOBAL} for a global attribute.
\item[{\tt name}]
\begin{deflist}{\texttt{cdiID}\ }
\item[\texttt{cdiID}]
CDI ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}}, {\htmlref{\texttt{gridCreate}}{gridCreate}} or {\htmlref{\texttt{streamInqVlist}}{streamInqVlist}}.
\item[\texttt{varID}]
Variable identifier, or {\texttt{CDI\_GLOBAL}} for a global attribute.
\item[\texttt{name}]
Attribute name.
\item[{\tt mlen}]
\item[\texttt{mlen}]
Number of allocated values provided for the attribute.
\item[{\tt ip}]
\item[\texttt{ip}]
Pointer location for returned integer attribute value(s).
\end{deflist}
\end{minipage}
\subsection{Define a floating point attribute: {\tt cdiDefAttFlt}}
\subsection{Define a floating point attribute: \texttt{cdiDefAttFlt}}
\index{cdiDefAttFlt}
\label{cdiDefAttFlt}
The function {\tt cdiDefAttFlt} defines a floating point attribute.
The function {\texttt{cdiDefAttFlt}} defines a floating point attribute.
\subsubsection*{Usage}
......@@ -133,29 +133,29 @@ The function {\tt cdiDefAttFlt} defines a floating point attribute.
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt cdiID\ }
\item[{\tt cdiID}]
CDI ID, from a previous call to {\htmlref{\tt vlistCreate}{vlistCreate}} or {\htmlref{\tt gridCreate}{gridCreate}}.
\item[{\tt varID}]
Variable identifier, or {\tt CDI\_GLOBAL} for a global attribute.
\item[{\tt name}]
\begin{deflist}{\texttt{cdiID}\ }
\item[\texttt{cdiID}]
CDI ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}} or {\htmlref{\texttt{gridCreate}}{gridCreate}}.
\item[\texttt{varID}]
Variable identifier, or {\texttt{CDI\_GLOBAL}} for a global attribute.
\item[\texttt{name}]
Attribute name.
\item[{\tt type}]
External data type ({\tt CDI\_DATATYPE\_FLT32} or {\tt CDI\_DATATYPE\_FLT64}).
\item[{\tt len}]
\item[\texttt{type}]
External data type ({\texttt{CDI\_DATATYPE\_FLT32}} or {\texttt{CDI\_DATATYPE\_FLT64}}).
\item[\texttt{len}]
Number of values provided for the attribute.
\item[{\tt dp}]
\item[\texttt{dp}]
Pointer to one or more floating point values.
\end{deflist}
\end{minipage}
\subsection{Get the value(s) of a floating point attribute: {\tt cdiInqAttFlt}}
\subsection{Get the value(s) of a floating point attribute: \texttt{cdiInqAttFlt}}
\index{cdiInqAttFlt}
\label{cdiInqAttFlt}
The function {\tt cdiInqAttFlt} gets the values(s) of a floating point attribute.
The function {\texttt{cdiInqAttFlt}} gets the values(s) of a floating point attribute.
\subsubsection*{Usage}
......@@ -164,27 +164,27 @@ The function {\tt cdiInqAttFlt} gets the values(s) of a floating point attribute
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt cdiID\ }
\item[{\tt cdiID}]
CDI ID, from a previous call to {\htmlref{\tt vlistCreate}{vlistCreate}}, {\htmlref{\tt gridCreate}{gridCreate}} or {\htmlref{\tt streamInqVlist}{streamInqVlist}}.
\item[{\tt varID}]
Variable identifier, or {\tt CDI\_GLOBAL} for a global attribute.
\item[{\tt name}]
\begin{deflist}{\texttt{cdiID}\ }
\item[\texttt{cdiID}]
CDI ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}}, {\htmlref{\texttt{gridCreate}}{gridCreate}} or {\htmlref{\texttt{streamInqVlist}}{streamInqVlist}}.
\item[\texttt{varID}]
Variable identifier, or {\texttt{CDI\_GLOBAL}} for a global attribute.
\item[\texttt{name}]
Attribute name.
\item[{\tt mlen}]
\item[\texttt{mlen}]
Number of allocated values provided for the attribute.
\item[{\tt dp}]
\item[\texttt{dp}]
Pointer location for returned floating point attribute value(s).
\end{deflist}
\end{minipage}
\subsection{Define a text attribute: {\tt cdiDefAttTxt}}
\subsection{Define a text attribute: \texttt{cdiDefAttTxt}}
\index{cdiDefAttTxt}
\label{cdiDefAttTxt}
The function {\tt cdiDefAttTxt} defines a text attribute.
The function {\texttt{cdiDefAttTxt}} defines a text attribute.
\subsubsection*{Usage}
......@@ -193,27 +193,27 @@ The function {\tt cdiDefAttTxt} defines a text attribute.
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt cdiID\ }
\item[{\tt cdiID}]
CDI ID, from a previous call to {\htmlref{\tt vlistCreate}{vlistCreate}} or {\htmlref{\tt gridCreate}{gridCreate}}.
\item[{\tt varID}]
Variable identifier, or {\tt CDI\_GLOBAL} for a global attribute.
\item[{\tt name}]
\begin{deflist}{\texttt{cdiID}\ }
\item[\texttt{cdiID}]
CDI ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}} or {\htmlref{\texttt{gridCreate}}{gridCreate}}.
\item[\texttt{varID}]
Variable identifier, or {\texttt{CDI\_GLOBAL}} for a global attribute.
\item[\texttt{name}]
Attribute name.
\item[{\tt len}]
\item[\texttt{len}]
Number of values provided for the attribute.
\item[{\tt tp}]
\item[\texttt{tp}]
Pointer to one or more character values.
\end{deflist}
\end{minipage}
\subsection{Get the value(s) of a text attribute: {\tt cdiInqAttTxt}}
\subsection{Get the value(s) of a text attribute: \texttt{cdiInqAttTxt}}
\index{cdiInqAttTxt}
\label{cdiInqAttTxt}
The function {\tt cdiInqAttTxt} gets the values(s) of a text attribute.
The function {\texttt{cdiInqAttTxt}} gets the values(s) of a text attribute.
\subsubsection*{Usage}
......@@ -222,16 +222,16 @@ The function {\tt cdiInqAttTxt} gets the values(s) of a text attribute.
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt cdiID\ }
\item[{\tt cdiID}]
CDI ID, from a previous call to {\htmlref{\tt vlistCreate}{vlistCreate}}, {\htmlref{\tt gridCreate}{gridCreate}} or {\htmlref{\tt streamInqVlist}{streamInqVlist}}.
\item[{\tt varID}]
Variable identifier, or {\tt CDI\_GLOBAL} for a global attribute.
\item[{\tt name}]
\begin{deflist}{\texttt{cdiID}\ }
\item[\texttt{cdiID}]
CDI ID, from a previous call to {\htmlref{\texttt{vlistCreate}}{vlistCreate}}, {\htmlref{\texttt{gridCreate}}{gridCreate}} or {\htmlref{\texttt{streamInqVlist}}{streamInqVlist}}.
\item[\texttt{varID}]
Variable identifier, or {\texttt{CDI\_GLOBAL}} for a global attribute.
\item[\texttt{name}]
Attribute name.
\item[{\tt mlen}]
\item[\texttt{mlen}]
Number of allocated values provided for the attribute.
\item[{\tt tp}]
\item[\texttt{tp}]
Pointer location for returned text attribute value(s).
\end{deflist}
......
......@@ -19,7 +19,7 @@ levels. Both variables are on the same lon/lat grid.
\subsection{Result}
This is the {\tt ncdump -h} output of the resulting NetCDF file {\tt example.nc}.
This is the \texttt{ncdump -h} output of the resulting NetCDF file \texttt{example.nc}.
\begin{lstlisting}[]
netcdf example {
......@@ -59,7 +59,7 @@ data:
\section{Read a dataset}
This example reads the NetCDF file {\tt example.nc} from \htmlref{Appendix B.1}{example_write}.
This example reads the NetCDF file \texttt{example.nc} from \htmlref{Appendix B.1}{example_write}.
\lstinputlisting[language=C]
{../../examples/cdi_read.c}
......@@ -67,9 +67,9 @@ This example reads the NetCDF file {\tt example.nc} from \htmlref{Appendix B.1}{
\section{Copy a dataset}
This example reads the NetCDF file {\tt example.nc} from \htmlref{Appendix B.1}{example_write}
This example reads the NetCDF file \texttt{example.nc} from \htmlref{Appendix B.1}{example_write}
and writes the result to a GRIB dataset by simple setting the output file type
to {\tt CDI\_FILETYPE\_GRB}.
to \texttt{CDI\_FILETYPE\_GRB}.
\lstinputlisting[language=C]
{../../examples/cdi_copy.c}
This diff is collapsed.
Every C file that references {\CDI} functions or constants must contain
an appropriate {\tt include} statement before the first such reference:
an appropriate \texttt{include} statement before the first such reference:
\begin{verbatim}
#include "cdi.h"
\end{verbatim}
Unless the {\tt cdi.h} file is installed in a standard directory where
C compiler always looks, you must use the {\tt -I} option when invoking
the compiler, to specify a directory where {\tt cdi.h} is installed, for example:
Unless the \texttt{cdi.h} file is installed in a standard directory where
C compiler always looks, you must use the \texttt{-I} option when invoking
the compiler, to specify a directory where \texttt{cdi.h} is installed, for example:
\begin{verbatim}
cc -c -I/usr/local/cdi/include myprogram.c
\end{verbatim}
Alternatively, you could specify an absolute path name in the {\tt include}
Alternatively, you could specify an absolute path name in the \texttt{include}
statement, but then your program would not compile on another platform
where {\CDI} is installed in a different location.
Unless the {\CDI} library is installed in a standard directory where the linker
always looks, you must use the {\tt -L} and {\tt -l} options to links an object file that
always looks, you must use the \texttt{-L} and \texttt{-l} options to links an object file that
uses the {\CDI} library. For example:
\begin{verbatim}
......
This diff is collapsed.
\subsection{Create a new dataset: {\tt streamOpenWrite}}
\subsection{Create a new dataset: \texttt{streamOpenWrite}}
\index{streamOpenWrite}
\label{streamOpenWrite}
The function {\tt streamOpenWrite} creates a new datset.
The function {\texttt{streamOpenWrite}} creates a new datset.
\subsubsection*{Usage}
\begin{verbatim}
......@@ -12,21 +12,21 @@ The function {\tt streamOpenWrite} creates a new datset.
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt filetype\ }
\item[{\tt path}]
\begin{deflist}{\texttt{filetype}\ }
\item[\texttt{path}]
The name of the new dataset.
\item[{\tt filetype}]
\item[\texttt{filetype}]
The type of the file format, one of the set of predefined {\CDI} file format types.
The valid {\CDI} file format types are {\tt CDI\_FILETYPE\_GRB}, {\tt CDI\_FILETYPE\_GRB2}, {\tt CDI\_FILETYPE\_NC},
{\tt CDI\_FILETYPE\_NC2}, {\tt CDI\_FILETYPE\_NC4}, {\tt CDI\_FILETYPE\_NC4C}, {\tt CDI\_FILETYPE\_SRV},
{\tt CDI\_FILETYPE\_EXT} and {\tt CDI\_FILETYPE\_IEG}.
The valid {\CDI} file format types are {\texttt{CDI\_FILETYPE\_GRB}}, {\texttt{CDI\_FILETYPE\_GRB2}}, {\texttt{CDI\_FILETYPE\_NC}},
{\texttt{CDI\_FILETYPE\_NC2}}, {\texttt{CDI\_FILETYPE\_NC4}}, {\texttt{CDI\_FILETYPE\_NC4C}}, {\texttt{CDI\_FILETYPE\_SRV}},
{\texttt{CDI\_FILETYPE\_EXT}} and {\texttt{CDI\_FILETYPE\_IEG}}.
\end{deflist}
\end{minipage}
\subsubsection*{Result}
Upon successful completion {\tt streamOpenWrite} returns an identifier to the
Upon successful completion {\texttt{streamOpenWrite}} returns an identifier to the
open stream. Otherwise, a negative number with the error status is returned.
......@@ -34,14 +34,14 @@ open stream. Otherwise, a negative number with the error status is returned.
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt CDI\_EUFILETYPE\ }
\item[{\tt CDI\_ESYSTEM}]
\begin{deflist}{\texttt{CDI\_EUFILETYPE}\ }
\item[\texttt{CDI\_ESYSTEM}]
Operating system error.
\item[{\tt CDI\_EINVAL}]
\item[\texttt{CDI\_EINVAL}]
Invalid argument.
\item[{\tt CDI\_EUFILETYPE}]
\item[\texttt{CDI\_EUFILETYPE}]
Unsupported file type.
\item[{\tt CDI\_ELIBNAVAIL}]
\item[\texttt{CDI\_ELIBNAVAIL}]
Library support not compiled in.
\end{deflist}
\end{minipage}
......@@ -49,7 +49,7 @@ Library support not compiled in.
\subsubsection*{Example}
Here is an example using {\tt streamOpenWrite} to create a new NetCDF file named {\tt foo.nc} for writing:
Here is an example using {\texttt{streamOpenWrite}} to create a new NetCDF file named {\texttt{foo.nc}} for writing:
\begin{lstlisting}[language=C, backgroundcolor=\color{pyellow}, basicstyle=\small, columns=flexible]
......@@ -63,11 +63,11 @@ Here is an example using {\tt streamOpenWrite} to create a new NetCDF file named
\end{lstlisting}
\subsection{Open a dataset for reading: {\tt streamOpenRead}}
\subsection{Open a dataset for reading: \texttt{streamOpenRead}}
\index{streamOpenRead}
\label{streamOpenRead}
The function {\tt streamOpenRead} opens an existing dataset for reading.
The function {\texttt{streamOpenRead}} opens an existing dataset for reading.
\subsubsection*{Usage}
......@@ -76,8 +76,8 @@ The function {\tt streamOpenRead} opens an existing dataset for reading.
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt path\ }
\item[{\tt path}]
\begin{deflist}{\texttt{path}\ }
\item[\texttt{path}]
The name of the dataset to be read.
\end{deflist}
......@@ -85,7 +85,7 @@ The name of the dataset to be read.
\subsubsection*{Result}
Upon successful completion {\tt streamOpenRead} returns an identifier to the
Upon successful completion {\texttt{streamOpenRead}} returns an identifier to the
open stream. Otherwise, a negative number with the error status is returned.
......@@ -93,14 +93,14 @@ open stream. Otherwise, a negative number with the error status is returned.
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt CDI\_EUFILETYPE\ }
\item[{\tt CDI\_ESYSTEM}]
\begin{deflist}{\texttt{CDI\_EUFILETYPE}\ }
\item[\texttt{CDI\_ESYSTEM}]
Operating system error.
\item[{\tt CDI\_EINVAL}]
\item[\texttt{CDI\_EINVAL}]
Invalid argument.
\item[{\tt CDI\_EUFILETYPE}]
\item[\texttt{CDI\_EUFILETYPE}]
Unsupported file type.
\item[{\tt CDI\_ELIBNAVAIL}]
\item[\texttt{CDI\_ELIBNAVAIL}]
Library support not compiled in.
\end{deflist}
\end{minipage}
......@@ -108,8 +108,8 @@ Library support not compiled in.
\subsubsection*{Example}
Here is an example using {\tt streamOpenRead} to open an existing NetCDF
file named {\tt foo.nc} for reading:
Here is an example using {\texttt{streamOpenRead}} to open an existing NetCDF
file named {\texttt{foo.nc}} for reading:
\begin{lstlisting}[language=C, backgroundcolor=\color{pyellow}, basicstyle=\small, columns=flexible]
......@@ -123,11 +123,11 @@ file named {\tt foo.nc} for reading:
\end{lstlisting}
\subsection{Close an open dataset: {\tt streamClose}}
\subsection{Close an open dataset: \texttt{streamClose}}
\index{streamClose}
\label{streamClose}
The function {\tt streamClose} closes an open dataset.
The function {\texttt{streamClose}} closes an open dataset.
\subsubsection*{Usage}
......@@ -136,19 +136,19 @@ The function {\tt streamClose} closes an open dataset.
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt streamID\ }
\item[{\tt streamID}]
Stream ID, from a previous call to {\htmlref{\tt streamOpenRead}{streamOpenRead}} or {\htmlref{\tt streamOpenWrite}{streamOpenWrite}}.
\begin{deflist}{\texttt{streamID}\ }
\item[\texttt{streamID}]
Stream ID, from a previous call to {\htmlref{\texttt{streamOpenRead}}{streamOpenRead}} or {\htmlref{\texttt{streamOpenWrite}}{streamOpenWrite}}.
\end{deflist}
\end{minipage}
\subsection{Get the filetype: {\tt streamInqFiletype}}
\subsection{Get the filetype: \texttt{streamInqFiletype}}
\index{streamInqFiletype}
\label{streamInqFiletype}
The function {\tt streamInqFiletype} returns the filetype of a stream.
The function {\texttt{streamInqFiletype}} returns the filetype of a stream.
\subsubsection*{Usage}
......@@ -157,28 +157,28 @@ The function {\tt streamInqFiletype} returns the filetype of a stream.
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt streamID\ }
\item[{\tt streamID}]
Stream ID, from a previous call to {\htmlref{\tt streamOpenRead}{streamOpenRead}} or {\htmlref{\tt streamOpenWrite}{streamOpenWrite}}.
\begin{deflist}{\texttt{streamID}\ }
\item[\texttt{streamID}]
Stream ID, from a previous call to {\htmlref{\texttt{streamOpenRead}}{streamOpenRead}} or {\htmlref{\texttt{streamOpenWrite}}{streamOpenWrite}}.
\end{deflist}
\end{minipage}
\subsubsection*{Result}
{\tt streamInqFiletype} returns the type of the file format,
{\texttt{streamInqFiletype}} returns the type of the file format,
one of the set of predefined {\CDI} file format types.
The valid {\CDI} file format types are {\tt CDI\_FILETYPE\_GRB}, {\tt CDI\_FILETYPE\_GRB2}, {\tt CDI\_FILETYPE\_NC}, {\tt CDI\_FILETYPE\_NC2},
{\tt CDI\_FILETYPE\_NC4}, {\tt CDI\_FILETYPE\_NC4C}, {\tt CDI\_FILETYPE\_SRV}, {\tt CDI\_FILETYPE\_EXT} and {\tt CDI\_FILETYPE\_IEG}.
The valid {\CDI} file format types are {\texttt{CDI\_FILETYPE\_GRB}}, {\texttt{CDI\_FILETYPE\_GRB2}}, {\texttt{CDI\_FILETYPE\_NC}}, {\texttt{CDI\_FILETYPE\_NC2}},
{\texttt{CDI\_FILETYPE\_NC4}}, {\texttt{CDI\_FILETYPE\_NC4C}}, {\texttt{CDI\_FILETYPE\_SRV}}, {\texttt{CDI\_FILETYPE\_EXT}} and {\texttt{CDI\_FILETYPE\_IEG}}.
\subsection{Define the byte order: {\tt streamDefByteorder}}
\subsection{Define the byte order: \texttt{streamDefByteorder}}
\index{streamDefByteorder}
\label{streamDefByteorder}
The function {\tt streamDefByteorder} defines the byte order of a binary dataset
with the file format type {\tt CDI\_FILETYPE\_SRV}, {\tt CDI\_FILETYPE\_EXT} or {\tt CDI\_FILETYPE\_IEG}.
The function {\texttt{streamDefByteorder}} defines the byte order of a binary dataset
with the file format type {\texttt{CDI\_FILETYPE\_SRV}}, {\texttt{CDI\_FILETYPE\_EXT}} or {\texttt{CDI\_FILETYPE\_IEG}}.
\subsubsection*{Usage}
......@@ -187,23 +187,23 @@ with the file format type {\tt CDI\_FILETYPE\_SRV}, {\tt CDI\_FILETYPE\_EXT} or
\end{verbatim}
\hspace*{4mm}\begin{minipage}[]{15cm}
\begin{deflist}{\tt byteorder\ }
\item[{\tt streamID}]