xsh_chap01.html

IEEE 1003.1-2003, Single Unix Specification v3

 The functionality described is optional. The functionality described is also an extension to the ISO&nbsp;C standard.</p>

<p>Where applicable, functions are marked with the TMR margin legend in the SYNOPSIS section. Where additional semantics apply to a
function, the material is identified by use of the TMR margin legend.</p>

<p><sup>[<a href="javascript:open_code('TPI')">TPI</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0">
Thread Priority Inheritance <img src="../images/opt-end.gif" alt="[Option End]" border="0"><br>
 The functionality described is optional. The functionality described is also an extension to the ISO&nbsp;C standard.</p>

<p>Where applicable, functions are marked with the TPI margin legend in the SYNOPSIS section. Where additional semantics apply to a
function, the material is identified by use of the TPI margin legend.</p>

<p><sup>[<a href="javascript:open_code('TPP')">TPP</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0">
Thread Priority Protection <img src="../images/opt-end.gif" alt="[Option End]" border="0"><br>
 The functionality described is optional. The functionality described is also an extension to the ISO&nbsp;C standard.</p>

<p>Where applicable, functions are marked with the TPP margin legend in the SYNOPSIS section. Where additional semantics apply to a
function, the material is identified by use of the TPP margin legend.</p>

<p><sup>[<a href="javascript:open_code('TPS')">TPS</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0">
Thread Execution Scheduling <img src="../images/opt-end.gif" alt="[Option End]" border="0"><br>
 The functionality described is optional. The functionality described is also an extension to the ISO&nbsp;C standard.</p>

<p>Where applicable, functions are marked with the TPS margin legend for the SYNOPSIS section. Where additional semantics apply to
a function, the material is identified by use of the TPS margin legend.</p>

<p><sup>[<a href="javascript:open_code('TRC')">TRC</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0">
Trace <img src="../images/opt-end.gif" alt="[Option End]" border="0"><br>
 The functionality described is optional. The functionality described is also an extension to the ISO&nbsp;C standard.</p>

<p>Where applicable, functions are marked with the TRC margin legend in the SYNOPSIS section. Where additional semantics apply to a
function, the material is identified by use of the TRC margin legend.</p>

<p><sup>[<a href="javascript:open_code('TRI')">TRI</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0">
Trace Inherit <img src="../images/opt-end.gif" alt="[Option End]" border="0"><br>
 The functionality described is optional. The functionality described is also an extension to the ISO&nbsp;C standard.</p>

<p>Where applicable, functions are marked with the TRI margin legend in the SYNOPSIS section. Where additional semantics apply to a
function, the material is identified by use of the TRI margin legend.</p>

<p><sup>[<a href="javascript:open_code('TRL')">TRL</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0">
Trace Log <img src="../images/opt-end.gif" alt="[Option End]" border="0"><br>
 The functionality described is optional. The functionality described is also an extension to the ISO&nbsp;C standard.</p>

<p>Where applicable, functions are marked with the TRL margin legend in the SYNOPSIS section. Where additional semantics apply to a
function, the material is identified by use of the TRL margin legend.</p>

<p><sup>[<a href="javascript:open_code('TSA')">TSA</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0">
Thread Stack Address Attribute <img src="../images/opt-end.gif" alt="[Option End]" border="0"><br>
 The functionality described is optional. The functionality described is also an extension to the ISO&nbsp;C standard.</p>

<p>Where applicable, functions are marked with the TSA margin legend for the SYNOPSIS section. Where additional semantics apply to
a function, the material is identified by use of the TSA margin legend.</p>

<p><sup>[<a href="javascript:open_code('TSF')">TSF</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0">
Thread-Safe Functions <img src="../images/opt-end.gif" alt="[Option End]" border="0"><br>
 The functionality described is optional. The functionality described is also an extension to the ISO&nbsp;C standard.</p>

<p>Where applicable, functions are marked with the TSF margin legend in the SYNOPSIS section. Where additional semantics apply to a
function, the material is identified by use of the TSF margin legend.</p>

<p><sup>[<a href="javascript:open_code('TSH')">TSH</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0">
Thread Process-Shared Synchronization <img src="../images/opt-end.gif" alt="[Option End]" border="0"><br>
 The functionality described is optional. The functionality described is also an extension to the ISO&nbsp;C standard.</p>

<p>Where applicable, functions are marked with the TSH margin legend in the SYNOPSIS section. Where additional semantics apply to a
function, the material is identified by use of the TSH margin legend.</p>

<p><sup>[<a href="javascript:open_code('TSP')">TSP</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0">
Thread Sporadic Server <img src="../images/opt-end.gif" alt="[Option End]" border="0"><br>
 The functionality described is optional. The functionality described is also an extension to the ISO&nbsp;C standard.</p>

<p>Where applicable, functions are marked with the TSP margin legend in the SYNOPSIS section. Where additional semantics apply to a
function, the material is identified by use of the TSP margin legend.</p>

<p><sup>[<a href="javascript:open_code('TSS')">TSS</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0">
Thread Stack Size Attribute <img src="../images/opt-end.gif" alt="[Option End]" border="0"><br>
 The functionality described is optional. The functionality described is also an extension to the ISO&nbsp;C standard.</p>

<p>Where applicable, functions are marked with the TSS margin legend in the SYNOPSIS section. Where additional semantics apply to a
function, the material is identified by use of the TSS margin legend.</p>

<p><sup>[<a href="javascript:open_code('TYM')">TYM</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0">
Typed Memory Objects <img src="../images/opt-end.gif" alt="[Option End]" border="0"><br>
 The functionality described is optional. The functionality described is also an extension to the ISO&nbsp;C standard.</p>

<p>Where applicable, functions are marked with the TYM margin legend in the SYNOPSIS section. Where additional semantics apply to a
function, the material is identified by use of the TYM margin legend.</p>

<p><sup>[<a href="javascript:open_code('UP')">UP</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0">
User Portability Utilities <img src="../images/opt-end.gif" alt="[Option End]" border="0"><br>
 The functionality described is optional.</p>

<p>Where applicable, utilities are marked with the UP margin legend in the SYNOPSIS section. Where additional semantics apply to a
utility, the material is identified by use of the UP margin legend.</p>

<p><sup>[<a href="javascript:open_code('XSI')">XSI</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0">
Extension <img src="../images/opt-end.gif" alt="[Option End]" border="0"><br>
 The functionality described is an XSI extension. Functionality marked XSI is also an extension to the ISO&nbsp;C standard.
Application writers may confidently make use of an extension on all systems supporting the X/Open System Interfaces Extension.</p>

<p>If an entire SYNOPSIS section is shaded and marked XSI, all the functionality described in that reference page is an extension.
See the Base Definitions volume of IEEE&nbsp;Std&nbsp;1003.1-2001, <a href="../basedefs/xbd_chap03.html#tag_03_439">Section 3.439,
XSI</a>.</p>

<p><sup>[<a href="javascript:open_code('XSR')">XSR</a>]</sup> <img src="../images/opt-start.gif" alt="[Option Start]" border="0">
XSI STREAMS <img src="../images/opt-end.gif" alt="[Option End]" border="0"><br>
 The functionality described is optional. The functionality described is also an extension to the ISO&nbsp;C standard.</p>

<p>Where applicable, functions are marked with the XSR margin legend in the SYNOPSIS section. Where additional semantics apply to a
function, the material is identified by use of the XSR margin legend.</p>

<h3><a name="tag_01_09"></a>Format of Entries</h3>

<p>The entries in <a href="xsh_chap03.html#tag_03"><i>System Interfaces</i></a> are based on a common format as follows. The only
sections relating to conformance are the SYNOPSIS, DESCRIPTION, RETURN VALUE, and ERRORS sections.</p>

<dl compact>
<dt><b>NAME</b></dt>

<dd><br>
This section gives the name or names of the entry and briefly states its purpose.</dd>

<dt><b>SYNOPSIS</b></dt>

<dd><br>
This section summarizes the use of the entry being described. If it is necessary to include a header to use this function, the
names of such headers are shown, for example: 

<blockquote>
<pre>
<tt>#include &lt;stdio.h&gt;
</tt>
</pre>
</blockquote>
</dd>

<dt><b>DESCRIPTION</b></dt>

<dd><br>
This section describes the functionality of the function or header.</dd>

<dt><b>RETURN VALUE</b></dt>

<dd><br>
This section indicates the possible return values, if any. 

<p>If the implementation can detect errors, &quot;successful completion&quot; means that no error has been detected during execution of the
function. If the implementation does detect an error, the error is indicated.</p>

<p>For functions where no errors are defined, &quot;successful completion&quot; means that if the implementation checks for errors, no
error has been detected. If the implementation can detect errors, and an error is detected, the indicated return value is returned
and <i>errno</i> may be set.</p>
</dd>

<dt><b>ERRORS</b></dt>

<dd><br>
This section gives the symbolic names of the error values returned by a function or stored into a variable accessed through the
symbol <i>errno</i> if an error occurs. 

<p>``No errors are defined&quot; means that error values returned by a function or stored into a variable accessed through the symbol
<i>errno</i>, if any, depend on the implementation.</p>
</dd>

<dt><b>EXAMPLES</b></dt>

<dd><br>
This section is informative. 

<p>This section gives examples of usage, where appropriate. In the event of conflict between an example and a normative part of
this volume of IEEE&nbsp;Std&nbsp;1003.1-2001, the normative material is to be taken as correct.</p>
</dd>

<dt><b>APPLICATION USAGE</b></dt>

<dd><br>
This section is informative. 

<p>This section gives warnings and advice to application writers about the entry. In the event of conflict between warnings and
advice and a normative part of this volume of IEEE&nbsp;Std&nbsp;1003.1-2001, the normative material is to be taken as correct.</p>
</dd>

<dt><b>RATIONALE</b></dt>

<dd><br>
This section is informative. 

<p>This section contains historical information concerning the contents of this volume of IEEE&nbsp;Std&nbsp;1003.1-2001 and why
features were included or discarded by the standard developers.</p>
</dd>

<dt><b>FUTURE DIRECTIONS</b></dt>

<dd><br>
This section is informative. 

<p>This section provides comments which should be used as a guide to current thinking; there is not necessarily a commitment to
adopt these future directions.</p>
</dd>

<dt><b>SEE ALSO</b></dt>

<dd><br>
This section is informative. 

<p>This section gives references to related information.</p>
</dd>

<dt><b>CHANGE HISTORY</b></dt>

<dd><br>
This section is informative. 

<p>This section shows the derivation of the entry and any significant changes that have been made to it.</p>
</dd>
</dl>

<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>