ADMIN(CP) XENIX System V ADMIN(CP)
Name
admin - Creates and administers SCCS files.
Syntax
admin [-n] [-i[name]] [-rrel]
[-fflag[flag-val]] [-dflag[flag-val]]
[-alogin] [-elogin] [-m[mrlist]] [-y[comment]] [-h] [-z]
files
Description
admin is used to create new SCCS files and to change
parameters of existing ones. Arguments to admin may appear
in any order. They consist of options, which begin with -,
and named files (note that SCCS filenames must begin with
the characters s.). If a named file doesn't exist, it is
created, and its parameters are initialized according to the
specified options. Parameters not initialized by a option
are assigned a default value. If a named file does exist,
parameters corresponding to specified options are changed,
and other parameters are left as is.
If a directory is named, admin behaves as though each file
in the directory were specified as a named file, except that
nonSCCS files (last component of the pathname does not begin
with s.) and unreadable files are silently ignored. If the
dash - is given, the standard input is read; each line of
the standard input is taken to be the name of an SCCS file
to be processed. Again, nonSCCS files and unreadable files
are silently ignored.
The options are as follows. Each is explained as though
only one named file is to be processed since the effects of
the arguments apply independently to each named file.
-n This option indicates that a new SCCS file is
to be created.
-i[name] The name of a file from which the text for a
new SCCS file is to be taken. The text
constitutes the first delta of the file (see
-r below for delta numbering scheme). If the
i option is used, but the filename is
omitted, the text is obtained by reading the
standard input until an end-of-file is
encountered. If this option is omitted, then
the SCCS file is created empty. Only one
SCCS file may be created by an admin command
on which the i option is supplied. Using a
single admin to create two or more SCCS files
require that they be created empty (no -i
option). Note that the -i option implies the
-n option.
Page 1 (printed 8/7/87)
ADMIN(CP) XENIX System V ADMIN(CP)
-rrel The release into which the initial delta is
inserted. This option may be used only if
the -i option is also used. If the -r option
is not used, the initial delta is inserted
into release 1. The level of the initial
delta is always 1 (by default initial deltas
are named 1.1).
-fflag This option specifies a flag, and possibly a
value for the flag, to be placed in the SCCS
file. Several f options may be supplied on a
single admin command line. The allowable
flags and their values are:
b Allows use of the -b option on a get(CP)
command to create branch deltas.
cceil The highest release (i.e., ``ceiling''),
a number less than or equal to 9999,
which may be retrieved by a get(CP)
command for editing. The default value
for an unspecified c flag is 9999.
ffloor The lowest release (i.e., ``floor''), a
number greater than 0 but less than
9999, which may be retrieved by a
get(CP) command for editing. The
default value for an unspecified f flag
is 1.
dSID The default delta number (SID) to be
used by a get(CP) command.
i Causes the ``No id keywords (ge6)''
message issued by get(CP) or delta(CP)
to be treated as a fatal error. In the
absence of this flag, the message is
only a warning. The message is issued
if no SCCS identification keywords (see
get(CP)) are found in the text retrieved
or stored in the SCCS file.
j Allows concurrent get(CP) commands for
editing on the same SID of an SCCS file.
This allows multiple concurrent updates
to the same version of the SCCS file.
llist A list of releases to which deltas can
no longer be made (get -e against one of
these ``locked'' releases fails). The
list has the following syntax:
Page 2 (printed 8/7/87)
ADMIN(CP) XENIX System V ADMIN(CP)
<list> ::= <range> | <list> , <range>
<range> ::= RELEASE NUMBER | a
The character a in the list is
equivalent to specifying all releases
for the named SCCS file.
n Causes delta(CP) to create a ``null''
delta in each of those releases (if any)
being skipped when a delta is made in a
new release (e.g., in making delta 5.1
after delta 2.7, releases 3 and 4 are
skipped). These null deltas serve as
``anchor points'' so that branch deltas
may later be created from them. The
absence of this flag causes skipped
releases to be nonexistent in the SCCS
file preventing branch deltas from being
created from them in the future.
qtext User-definable text substituted for all
occurrences of the keyword in SCCS file
text retrieved by get(CP).
mmod module name of the SCCS file substituted
for all occurrences of the admin.CP
keyword in SCCS file text retrieved by
get(CP). If the m flag is not
specified, the value assigned is the
name of the SCCS file with the leading
s. removed.
ttype type of module in the SCCS file
substituted for all occurrences of
keyword in SCCS file text retrieved by
get(CP).
v[pgm] Causes delta(CP) to prompt for
Modification Request (MR) numbers as the
reason for creating a delta. The
optional value specifies the name of an
MR number validity checking program (see
delta(CP)). (If this flag is set when
creating an SCCS file, the m option must
also be used even if its value is null).
-d[flag] Causes removal (deletion) of the specified
flag from an SCCS file. The -d option may be
specified only when processing existing SCCS
files. Several -d options may be supplied on
a single admin command. See the -f option
for allowable flag names.
Page 3 (printed 8/7/87)
ADMIN(CP) XENIX System V ADMIN(CP)
llist A list of releases to be ``unlocked''.
See the -f option for a description of
the l flag and the syntax of a list.
-alogin A login name, or numerical XENIX group ID, to
be added to the list of users which may make
deltas (changes) to the SCCS file. A group
ID is equivalent to specifying all login
names common to that group ID. Several a
options may be used on a single admin command
line. As many logins, or numerical group
IDs, as desired may be on the list
simultaneously. If the list of users is
empty, then anyone may add deltas.
-elogin A login name, or numerical group ID, to be
erased from the list of users allowed to make
deltas (changes) to the SCCS file.
Specifying a group ID is equivalent to
specifying all login names common to that
group ID. Several e options may be used on a
single admin command line.
-y[comment] The comment text is inserted into the SCCS
file as a comment for the initial delta in a
manner identical to that of delta(CP).
Omission of the -y option results in a
default comment line being inserted in the
form:
YY/MM/DD HH:MM:SS by login
The -y option is valid only if the -i and/or -n
options are specified (i.e., a new SCCS file is
being created).
-m[mrlist] The list of Modification Requests (MR)
numbers is inserted into the SCCS file as the
reason for creating the initial delta in a
manner identical to delta(CP). The v flag
must be set and the MR numbers are validated
if the v flag has a value (the name of an MR
number validation program). Diagnostics will
occur if the v flag is not set or MR
validation fails.
-h Causes admin to check the structure of the
SCCS file (see sccsfile(F)), and to compare a
newly computed checksum (the sum of all the
characters in the SCCS file except those in
the first line) with the checksum that is
stored in the first line of the SCCS file.
Page 4 (printed 8/7/87)
ADMIN(CP) XENIX System V ADMIN(CP)
Appropriate error diagnostics are produced.
This option inhibits writing on the file,
nullifying the effect of any other options
supplied, and is therefore only meaningful
when processing existing files.
-z The SCCS file checksum is recomputed and
stored in the first line of the SCCS file
(see -h, above).
Note that use of this option on a truly
corrupted file may prevent future detection
of the corruption.
Files
The last component of all SCCS filenames must be of the form
s.file-name. New SCCS files are created read-only (444
modified by umask) (see chmod(C)). Write permission in the
pertinent directory is, of course, required to create a
file. All writing done by admin is to a temporary x-file,
called x.filename, (see get(CP)), created with read-only
permission if the admin command is creating a new SCCS file,
or with the same mode as the SCCS file if it exists. After
successful execution of admin, the SCCS file is removed (if
it exists), and the x-file is renamed with the name of the
SCCS file. This ensures that changes are made to the SCCS
file only if no errors occurred.
It is recommended that directories containing SCCS files be
mode 755 and that SCCS files themselves be read-only. The
mode of the directories allows 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.
If it should be necessary to patch an SCCS file for any
reason, the mode may be changed to 644 by the owner allowing
use of a text editor. Care must be taken! The edited file
should always be processed by an admin -h to check for
corruption followed by an admin -z to generate a proper
checksum. Another admin -h is recommended to ensure the
SCCS file is valid.
admin also makes use of a transient lock file (called
z.filename), which is used to prevent simultaneous updates
to the SCCS file by different users. See get(CP) for
further information.
See Also
delta(CP), ed(C), get(CP), help(CP), prs(CP), what(C),
sccsfile(F)
Page 5 (printed 8/7/87)
ADMIN(CP) XENIX System V ADMIN(CP)
Diagnostics
Use help(CP) for explanations.
Page 6 (printed 8/7/87)