admin.html

IEEE 1003.1-2003, Single Unix Specification v3

</tt>
</pre>

<p>where &lt;<i>date</i>&gt; is expressed in the format of the <a href="../utilities/date.html"><i>date</i></a> utility's
<tt>%y</tt> / <tt>%m</tt> / <tt>%d</tt> conversion specification, &lt;<i>time</i>&gt; in the format of the <a href=
"../utilities/date.html"><i>date</i></a> utility's <tt>%T</tt> conversion specification format, and &lt;<i>login</i>&gt; is the
login name of the user creating the file.</p>
</dd>

<dt><b>-m&nbsp;</b> <i>mrlist</i></dt>

<dd>Insert the list of modification request (MR) numbers into the SCCS file as the reason for creating the initial delta in a
manner identical to <a href="../utilities/delta.html"><i>delta</i></a>. The application shall ensure that the <b>v</b> flag is set
and the MR numbers are validated if the <b>v</b> flag has a value (the name of an MR number validation program). A diagnostic
message shall be written if the <b>v</b> flag is not set or MR validation fails.</dd>

<dt><b>-h</b></dt>

<dd>Check the structure of the SCCS file and compare the newly computed checksum with the checksum that is stored in the SCCS file.
If the newly computed checksum does not match the checksum in the SCCS file, a diagnostic message shall be written.</dd>

<dt><b>-z</b></dt>

<dd>Recompute the SCCS file checksum and store it in the first line of the SCCS file (see the <b>-h</b> option above). Note that
use of this option on a truly corrupted file may prevent future detection of the corruption.</dd>
</dl>
</blockquote>

<h4><a name="tag_04_01_05"></a>OPERANDS</h4>

<blockquote>
<p>The following operands shall be supported:</p>

<dl compact>
<dt><i>file</i></dt>

<dd>A pathname of an existing SCCS file or a directory. If <i>file</i> is a directory, the <i>admin</i> utility shall behave as
though each file in the directory were specified as a named file, except that non-SCCS files (last component of the pathname does
not begin with <b>s.</b>) and unreadable files shall be silently ignored.</dd>

<dt><i>newfile</i></dt>

<dd>A pathname of an SCCS file to be created.</dd>
</dl>

<p>If exactly one <i>file</i> or <i>newfile</i> operand appears, and it is <tt>'-'</tt> , the standard input shall be read; each
line of the standard input shall be taken to be the name of an SCCS file to be processed. Non-SCCS files and unreadable files shall
be silently ignored.</p>
</blockquote>

<h4><a name="tag_04_01_06"></a>STDIN</h4>

<blockquote>
<p>The standard input shall be a text file used only if <b>-i</b> is specified without an option-argument or if a <i>file</i> or
<i>newfile</i> operand is specified as <tt>'-'</tt> . If the first character of any standard input line is &lt;SOH&gt; in the POSIX
locale, the results are unspecified.</p>
</blockquote>

<h4><a name="tag_04_01_07"></a>INPUT FILES</h4>

<blockquote>
<p>The existing SCCS files shall be text files of an unspecified format.</p>

<p>The application shall ensure that the file named by the <b>-i</b> option's <i>name</i> option-argument shall be a text file; if
the first character of any line in this file is &lt;SOH&gt; in the POSIX locale, the results are unspecified. If this file contains
more than 99999 lines, the number of lines recorded in the header for this file shall be 99999 for this delta.</p>
</blockquote>

<h4><a name="tag_04_01_08"></a>ENVIRONMENT VARIABLES</h4>

<blockquote>
<p>The following environment variables shall affect the execution of <i>admin</i>:</p>

<dl compact>
<dt><i>LANG</i></dt>

<dd>Provide a default value for the internationalization variables that are unset or null. (See the Base Definitions volume of
IEEE&nbsp;Std&nbsp;1003.1-2001, <a href="../basedefs/xbd_chap08.html#tag_08_02">Section 8.2, Internationalization Variables</a> for
the precedence of internationalization variables used to determine the values of locale categories.)</dd>

<dt><i>LC_ALL</i></dt>

<dd>If set to a non-empty string value, override the values of all the other internationalization variables.</dd>

<dt><i>LC_CTYPE</i></dt>

<dd>Determine the locale for the interpretation of sequences of bytes of text data as characters (for example, single-byte as
opposed to multi-byte characters in arguments and input files).</dd>

<dt><i>LC_MESSAGES</i></dt>

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

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

<dd>Determine the location of message catalogs for the processing of <i>LC_MESSAGES .</i></dd>
</dl>
</blockquote>

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

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

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

<blockquote>
<p>Not used.</p>
</blockquote>

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

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

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

<blockquote>
<p>Any SCCS files created shall be text files of an unspecified format. During processing of a <i>file</i>, a locking
<i>z-file</i>, as described in <a href="get.html"><i>get</i></a> , may be created and deleted.</p>
</blockquote>

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

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

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

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

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

<dd>Successful completion.</dd>

<dt>&gt;0</dt>

<dd>An error occurred.</dd>
</dl>
</blockquote>

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

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

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

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

<blockquote>
<p>It is recommended that directories containing SCCS files be writable by the owner only, and that SCCS files themselves be
read-only. The mode of the directories should allow only the owner to modify SCCS files contained in the directories. The mode of
the SCCS files prevents any modification at all except by SCCS commands.</p>
</blockquote>

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

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

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

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

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

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

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

<blockquote>
<p><a href="delta.html"><i>delta</i></a> , <a href="get.html"><i>get</i></a> , <a href="prs.html"><i>prs</i></a> , <a href=
"what.html"><i>what</i></a></p>
</blockquote>

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

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

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

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

<p>The normative text is reworded to emphasize the term &quot;shall&quot; for implementation requirements.</p>

<p>The grammar is updated.</p>

<p>The Open Group Base Resolution bwg2001-007 is applied, adding new text to the INPUT FILES section warning that the maximum lines
recorded in the file is 99999.</p>

<p>The Open Group Base Resolution bwg2001-009 is applied, amending the description of the <b>-h</b> option.</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>