EVOLUTION-MANAGER

Edit File: udunits2prog.html

<html lang="en">
<head>
<title>udunits2 Program Guide</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="udunits2 Program Guide">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="top" href="#Top">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--

This software was developed by the Unidata Program Center of the
University Corporation for Atmospheric Research (UCAR)
<http://www.unidata.ucar.edu>.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

1) Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.
   2) Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
   3) Neither the names of the development group, the copyright holders, nor the
      names of contributors may be used to endorse or promote products derived
      from this software without specific prior written permission.
   4) This license shall terminate automatically and you may no longer exercise
      any of the rights granted to you by this license as of the date you
      commence an action, including a cross-claim or counterclaim, against
      the copyright holders or any contributor alleging that this software
      infringes a patent. This termination provision shall not apply for an
      action alleging patent infringement by combinations of this software with
      other software or hardware.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE CONTRIBUTORS
OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE SOFTWARE.
-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"></style>
</head>
<body>
<h1 class="settitle">udunits2 Program Guide</h1>
<div class="contents">
<h2>Table of Contents</h2>
<ul>
<li><a name="toc_Top" href="#Top">udunits2</a>
<li><a name="toc_Synopsis" href="#Synopsis">1 Synopsis</a>
<li><a name="toc_Options" href="#Options">2 Options</a>
<li><a name="toc_Description" href="#Description">3 Description</a>
<li><a name="toc_See-Also" href="#See-Also">4 See Also</a>
<li><a name="toc_Complete-Index" href="#Complete-Index">Index</a>
</li></ul>
</div>

<div class="node">
<a name="Top"></a>
<p><hr>
Next:&nbsp;<a rel="next" accesskey="n" href="#Synopsis">Synopsis</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="#dir">(dir)</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="#dir">(dir)</a>

</div>

<h2 class="unnumbered">udunits2</h2>

<p>This manual describes how to use the <code>udunits2</code> program. 
This program allows you to discover the definition of a unit
as well as convert numeric values between compatible units.

<p>This software was developed by the Unidata Program Center of the
University Corporation for Atmospheric Research (UCAR)
&lt;http://www.unidata.ucar.edu&gt;.

<p>Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

<p>1) Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer. 
   2) Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution. 
   3) Neither the names of the development group, the copyright holders, nor the
      names of contributors may be used to endorse or promote products derived
      from this software without specific prior written permission. 
   4) This license shall terminate automatically and you may no longer exercise
      any of the rights granted to you by this license as of the date you
      commence an action, including a cross-claim or counterclaim, against
      the copyright holders or any contributor alleging that this software
      infringes a patent. This termination provision shall not apply for an
      action alleging patent infringement by combinations of this software with
      other software or hardware.

<p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE CONTRIBUTORS
OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS WITH THE SOFTWARE.

<ul class="menu">
<li><a accesskey="1" href="#Synopsis">Synopsis</a>:             Terse usage example
<li><a accesskey="2" href="#Options">Options</a>:              Command-line options
<li><a accesskey="3" href="#Description">Description</a>:          Description of the program
<li><a accesskey="4" href="#See-Also">See Also</a>:             Additional information
<li><a accesskey="5" href="#Complete-Index">Complete Index</a>:       Complete index
</ul>

<div class="node">
<a name="Synopsis"></a>
<p><hr>
Next:&nbsp;<a rel="next" accesskey="n" href="#Options">Options</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="#Top">Top</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>

</div>

<h2 class="chapter">1 Synopsis</h2>

<p><a name="index-synopsis-1"></a>
<pre class="example">     udunits2 -h
</pre>
   <pre class="example">     udunits2 [-A|-L|-U] [-r] [-H have] [-W want] [XML_file]
</pre>
   <div class="node">
<a name="Options"></a>
<p><hr>
Next:&nbsp;<a rel="next" accesskey="n" href="#Description">Description</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="#Synopsis">Synopsis</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>

</div>

<h2 class="chapter">2 Options</h2>

<p><a name="index-options-2"></a>
The following options and arguments are supported:

<dl>
<dt><code>-A</code><dd>Use the ASCII character-set. 
<br><dt><code>-L</code><dd>Use the ISO Latin-1 (ISO-8859-1) character-set. 
<br><dt><code>-U</code><dd>Use the full Unicode character-set with UTF-8 encoding. 
<br><dt><code>-h</code><dd>Print a help message. 
<br><dt><code>-r</code><dd>Reveal any problems with the units database (by default, no error messages are
printed during import of the database). 
<br><dt><code>-H have</code><dd>Use <code>have</code> unit for conversion. The default is the reply to the prompt. 
<br><dt><code>-W want</code><dd>Use <code>want</code> unit for conversion. An empty string requests the definition of
the <code>have</code> unit. The default is the reply to the prompt. 
<br><dt><code>XML_file</code><dd>The pathname of the XML-formatted units database. 
If not specified, then the default, compile-time pathname is used. 
</dl>

<div class="node">
<a name="Description"></a>
<p><hr>
Next:&nbsp;<a rel="next" accesskey="n" href="#See-Also">See Also</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="#Options">Options</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>

</div>

<h2 class="chapter">3 Description</h2>

<p>When successfully started without the <code>-H have</code> or <code>-W want</code> options,
the program will print the prompt

<pre class="example">     You have:
</pre>
   <p>At this point you can exit the program by entering the end-of-file character
(usually control-D) or continue by entering either a value or a unit. 
(a value comprises a numerical value and a unit. 
For example,

<pre class="example">     You have: 80 km/h
     You want:
</pre>
   <p>At this point, if you enter a blank line, then the program will assume
that you entered a unit in the previous line and will print
the definition of that unit in terms of the base units of the
unit-system that it imported on startup.  For example,

<pre class="example">     You have: 80 km/h
     You want:
         22.2222222222222 m.s-1
     You have:
</pre>
   <p>Details of the formatting depend on the character-set being used. 
See <a href="#Options">Options</a>.

<p>Alternatively, at the &ldquo;<kbd>You want:</kbd>&rdquo; prompt you can enter the unit
in which you want the previously-entered value. 
For example,

<pre class="example">     You have: 80 km/h
     You want: mi/h
         80 km/h = 49.7097 mi/h
         x/(mi/h) = 0.621371*(x/(km/h))
     You have:
</pre>
   <p>The first line after &ldquo;<kbd>You want:</kbd>&rdquo; shows the &ldquo;have&rdquo; value in the
desired &ldquo;want&rdquo; unit.

<p>The second line shows the transformation between numerical values
in the &ldquo;have&rdquo; unit to numerical values in the &ldquo;want&rdquo; unit.  The
symbol &ldquo;<kbd>x</kbd>&rdquo; represents the physical quantity in question. 
See <a href="http://physics.nist.gov/Pubs/SP811/sec07.html">http://physics.nist.gov/Pubs/SP811/sec07.html</a>.

<div class="node">
<a name="See-Also"></a>
<p><hr>
Next:&nbsp;<a rel="next" accesskey="n" href="#Complete-Index">Complete Index</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="#Description">Description</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>

</div>

<p>See <a href="udunits2lib.html#Top">UDUNITS-2</a>, for
information on the UDUNITS-2 library, which is used by this program.

<div class="node">
<a name="Complete-Index"></a>
<p><hr>
Previous:&nbsp;<a rel="previous" accesskey="p" href="#See-Also">See Also</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="#Top">Top</a>

</div>

<h2 class="unnumbered">Index</h2>

<ul class="index-cp" compact>
<li><a href="#index-options-2">options</a>: <a href="#Options">Options</a></li>
<li><a href="#index-synopsis-1">synopsis</a>: <a href="#Synopsis">Synopsis</a></li>
   </ul></body></html>