localedef.html

IEEE 1003.1-2003, Single Unix Specification v3

<dd>Determine the locale that should be used to affect the format and contents of diagnostic messages written to standard
error.</dd>

<dt><i>NLSPATH</i></dt>

<dd><sup>[<a href="javascript:open_code('XSI')">XSI</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0">
Determine the location of message catalogs for the processing of <i>LC_MESSAGES .</i> <img src="../images/opt-end.gif" alt=
"[Option End]" border="0"></dd>
</dl>
</blockquote>

<h4><a name="tag_04_77_09"></a>ASYNCHRONOUS EVENTS</h4>

<blockquote>
<p>Default.</p>
</blockquote>

<h4><a name="tag_04_77_10"></a>STDOUT</h4>

<blockquote>
<p>The utility shall report all categories successfully processed, in an unspecified format.</p>
</blockquote>

<h4><a name="tag_04_77_11"></a>STDERR</h4>

<blockquote>
<p>The standard error shall be used only for diagnostic messages.</p>
</blockquote>

<h4><a name="tag_04_77_12"></a>OUTPUT FILES</h4>

<blockquote>
<p>The format of the created output is unspecified. If the <i>name</i> operand does not contain a slash, the existence of an output
file for the locale is unspecified.</p>
</blockquote>

<h4><a name="tag_04_77_13"></a>EXTENDED DESCRIPTION</h4>

<blockquote>
<p>When the <b>-u</b> option is used, the <i>code_set_name</i> option-argument shall be interpreted as an implementation-defined
name of a codeset to which the ISO/IEC&nbsp;10646-1:2000 standard position constant values shall be converted via an
implementation-defined method. Both the ISO/IEC&nbsp;10646-1:2000 standard position constant values and other formats (decimal,
hexadecimal, or octal) shall be valid as encoding values within the <i>charmap</i> file. The codeset represented by the
implementation-defined name can be any codeset that is supported by the implementation.</p>

<p>When conflicts occur between the <i>charmap</i> specification of &lt;<i>code_set_name</i>&gt;, &lt;<i>mb_cur_max</i>&gt;, or
&lt;<i>mb_cur_min</i>&gt; and the implementation-defined interpretation of these respective items for the codeset represented by
the <b>-u</b> option-argument <i>code_set_name</i>, the result is unspecified.</p>

<p>When conflicts occur between the <i>charmap</i> encoding values specified for symbolic names of characters of the portable
character set and the implementation-defined assignment of character encoding values, the result is unspecified.</p>

<p>If a non-printable character in the <i>charmap</i> has a width specified that is not <b>-1</b>, <i>localedef</i> shall generate
a warning.</p>
</blockquote>

<h4><a name="tag_04_77_14"></a>EXIT STATUS</h4>

<blockquote>
<p>The following exit values shall be returned:</p>

<dl compact>
<dt>&nbsp;0</dt>

<dd>No errors occurred and the locales were successfully created.</dd>

<dt>&nbsp;1</dt>

<dd>Warnings occurred and the locales were successfully created.</dd>

<dt>&nbsp;2</dt>

<dd>The locale specification exceeded implementation limits or the coded character set or sets used were not supported by the
implementation, and no locale was created.</dd>

<dt>&nbsp;3</dt>

<dd>The capability to create new locales is not supported by the implementation.</dd>

<dt>&gt;3</dt>

<dd>Warnings or errors occurred and no output was created.</dd>
</dl>
</blockquote>

<h4><a name="tag_04_77_15"></a>CONSEQUENCES OF ERRORS</h4>

<blockquote>
<p>If an error is detected, no permanent output shall be created.</p>

<p>If warnings occur, permanent output shall be created if the <b>-c</b> option was specified. The following conditions shall cause
warning messages to be issued:</p>

<ul>
<li>
<p>If a symbolic name not found in the <i>charmap</i> file is used for the descriptions of the <i>LC_CTYPE</i> or <i>LC_COLLATE</i>
categories (for other categories, this shall be an error condition).</p>
</li>

<li>
<p>If the number of operands to the <b>order</b> keyword exceeds the {COLL_WEIGHTS_MAX} limit.</p>
</li>

<li>
<p>If optional keywords not supported by the implementation are present in the source.</p>
</li>

<li>
<p>If a non-printable character has a width specified other than -1.</p>
</li>
</ul>

<p>Other implementation-defined conditions may also cause warnings.</p>
</blockquote>

<hr>
<div class="box"><em>The following sections are informative.</em></div>

<h4><a name="tag_04_77_16"></a>APPLICATION USAGE</h4>

<blockquote>
<p>The <i>charmap</i> definition is optional, and is contained outside the locale definition. This allows both completely
self-defined source files, and generic sources (applicable to more than one codeset). To aid portability, all <i>charmap</i>
definitions must use the same symbolic names for the portable character set. As explained in the Base Definitions volume of
IEEE&nbsp;Std&nbsp;1003.1-2001, <a href="../basedefs/xbd_chap06.html#tag_06_04">Section 6.4, Character Set Description File</a>, it
is implementation-defined whether or not users or applications can provide additional character set description files. Therefore,
the <b>-f</b> option might be operable only when an implementation-defined <i>charmap</i> is named.</p>
</blockquote>

<h4><a name="tag_04_77_17"></a>EXAMPLES</h4>

<blockquote>
<p>None.</p>
</blockquote>

<h4><a name="tag_04_77_18"></a>RATIONALE</h4>

<blockquote>
<p>The output produced by the <i>localedef</i> utility is implementation-defined. The <i>name</i> operand is used to identify the
specific locale. (As a consequence, although several categories can be processed in one execution, only categories belonging to the
same locale can be processed.)</p>
</blockquote>

<h4><a name="tag_04_77_19"></a>FUTURE DIRECTIONS</h4>

<blockquote>
<p>None.</p>
</blockquote>

<h4><a name="tag_04_77_20"></a>SEE ALSO</h4>

<blockquote>
<p><a href="locale.html"><i>locale</i></a> , the Base Definitions volume of IEEE&nbsp;Std&nbsp;1003.1-2001, <a href=
"../basedefs/xbd_chap07.html#tag_07_03">Section 7.3, Locale Definition</a></p>
</blockquote>

<h4><a name="tag_04_77_21"></a>CHANGE HISTORY</h4>

<blockquote>
<p>First released in Issue 4.</p>
</blockquote>

<h4><a name="tag_04_77_22"></a>Issue 6</h4>

<blockquote>
<p>The <b>-u</b> option is added, as specified in the IEEE&nbsp;P1003.2b draft standard.</p>

<p>The normative text is reworded to avoid use of the term &quot;must&quot; for application requirements.</p>
</blockquote>

<div class="box"><em>End of informative text.</em></div>

<hr>
<hr size="2" noshade>
<center><font size="2"><!--footer start-->
UNIX &reg; is a registered Trademark of The Open Group.<br>
POSIX &reg; is a registered Trademark of The IEEE.<br>
[ <a href="../mindex.html">Main Index</a> | <a href="../basedefs/contents.html">XBD</a> | <a href=
"../utilities/contents.html">XCU</a> | <a href="../functions/contents.html">XSH</a> | <a href="../xrat/contents.html">XRAT</a>
]</font></center>

<!--footer end-->
<hr size="2" noshade>
</body>
</html>