admin(1) admin(1)
NAME
admin - create and administer SCCS files
SYNOPSIS
admin [option...] file...
DESCRIPTION
admin is used to create new SCCS files and to change parameters of
existing ones. Note that SCCS filenames must begin with the characters
s.. If a named file does not exist, it is created and its parameters
are initialized according to the specified keyletter arguments. Param-
eters not initialized by a keyletter argument are assigned a default
value. If the file does exist, parameters corresponding to specified
keyletter arguments are changed, and other parameters are left
unchanged.
If a directory is named, admin behaves as though each file in the
directory were specified as a named file. Unreadable files and files
whose names do not begin with s. are ignored, without comment. If the
filename is specified as -, the standard input is read; each line of
the standard input is taken to be the name of an SCCS file to be pro-
cessed. Again, non-SCCS files and unreadable files are ignored without
comment.
OPTIONS
The options (keyletters) and their arguments are listed below. Each
argument is explained as if only one named file were to be processed,
because the effect of each argument applies independently to each
named file.
-n indicates that a new SCCS file is to be created. If -i is not
specified, the file contains only control information.
-i[name]
specifies 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
keyletter for the delta numbering scheme). If the -i keyletter is
used, but no filename is specified, the text is expected on the
standard input. If -i is specified, then only one SCCS file can
be created. Note that the keyletter -i implies the keyletter -n.
-r version
specifies the version (release number) into which the initial
delta is inserted.
This keyletter may be used only if the -i keyletter is also used.
If the -r keyletter 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).
Page 1 Reliant UNIX 5.44 Printed 11/98
admin(1) admin(1)
-t[name]
specifies the name of a file from which descriptive text for the
SCCS file is to be taken.
In the case of existing SCCS files, the following apply: a -t
keyletter without a filename causes removal of the descriptive
text that is currently in the SCCS file; a -t keyletter with a
filename causes text (if any) in the named file to replace the
descriptive text which is currently in the SCCS file.
-f flag
specifies the value for a flag to be given to the SCCS file.
Several -f keyletters may be used in a single admin command line.
The allowable flags and their values are:
b Allows use of the -b keyletter with a get command to
create branch deltas.
cceil Specifies the highest version (i.e. ceiling) which the
file can be given. ceil must lie between 1 and 9999
(inclusive). The default value if c is not specified is
9999.
ffloor Specifies the number of the first version (i.e. floor).
floor must lie between 0 and 10000 (exclusive). The
default value if f is not specified is 1.
dSID The default delta number (SID) to be used by a get com-
mand.
i[str] Causes the No id keywords (ge6) message issued by get or
delta to be treated as a fatal error. The default is that
this message is only issued as a warning. The message is
issued if no SCCS identification keywords [see get(1)]
are found in the text retrieved or stored in the SCCS
file. If a value is supplied, the keywords must exactly
match the given string. The string must contain exactly
one keyword, and no newlines.
j Allows multiple concurrent get commands for editing on
the same SID of an SCCS file. This flag allows multiple
concurrent updates to the same version of the SCCS file.
Page 2 Reliant UNIX 5.44 Printed 11/98
admin(1) admin(1)
llist A list of versions (release numbers) to which deltas can
no longer be made. get -e against one of these "locked"
releases fails. The list has the following syntax:
<list> ::= <range> | <list> , <range>
<range> ::= <releasenumber> | a
The character a in the list indicates that all releases
for the named SCCS file are to be locked.
n Causes delta 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 non-existent in the SCCS file, preventing
branch deltas from being created from them in the future.
qtext User-definable text which will be substituted for every
occurrence of the %Q% keyword in the SCCS file retrieved
by get.
mmod The module name of the SCCS file which will be substi-
tuted for every occurrence of the %M% keyword in SCCS
file text retrieved by get. If the m keyletter is not
specified, the value assigned is the name of the SCCS
file with the leading s. removed.
ttype Specifies the type of module in the SCCS file substituted
for every occurrence of %Y% keyword in SCCS file text
retrieved by get.
v[pgm] Causes delta to prompt for Modification Request (MR)
numbers as the reason for creating a delta.
The optional argument specifies the name of an MR number
validity checking program [see delta(1)]. This program
will receive as arguments the module name, the value of
the type flag (see ttype above), and the MR-list. If this
keyletter is set when creating an SCCS file, the m
keyletter must also be used even if the MR list is empty.
-d flag
flag is deleted from the SCCS file.
In any one admin command, a number of -d keyletters may be used.
See the -f keyletter for allowable flag values.
Page 3 Reliant UNIX 5.44 Printed 11/98
admin(1) admin(1)
-a login
A login name, or numerical group ID can be added to the list of
users who 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 keyletters 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. If a login or group ID is preceded by
a !, these users are explicitly denied permission to make deltas.
-e login
A login name, or numerical group ID, to be erased from the list
of users allowed to make deltas to the SCCS file.
Specifying a group ID is equivalent to specifying all login names
included under that group ID. Several -e keyletters may be used
on a single admin command line.
-m MR-list
The list of Modification Request (MR) numbers is inserted into
the SCCS file as the reason for creating the initial delta in a
manner identical to delta.
The v flag must be set in the -f keyletter, and the MR numbers
will be validated if the v flag has an argument (the name of an
MR number validation program). A message will be output if the v
flag is not set or MR validation fails.
-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.
Omission of the -y keyletter results in a default comment line
being inserted:
date and time created <date> <time> by <login>
The -y keyletter is valid only if the -i and/or -n keyletters are
specified, i.e. a new SCCS file is being created.
-h admin will check the structure of the SCCS file [see
sccsfile(4)].
A newly computed check-sum (the sum of all the characters in the
SCCS file except those in the first line) will be compared with
the check-sum that is stored in the first line of the SCCS file,
and if appropriate an error message will be output.
The keyletter -h cannot be combined with other keyletters. It
inhibits writing to the file, nullifying the effect of all other
keyletters supplied.
Page 4 Reliant UNIX 5.44 Printed 11/98
admin(1) admin(1)
-z The SCCS file check-sum will be recomputed and stored in the
first line of the SCCS file (see -h).
Note that use of this keyletter on a severely corrupted file may
prevent future detection of the corruption.
The keyletter -z cannot be combined with other options.
-- If the first filename begins with a dash (-), the end of the
command-line options must be marked with --.
The name of any SCCS file, omitting the path details, must be in the
form s.filename. New SCCS files are set up using mode 444 (provided
the permissions have not been restricted by umask). Write permission
in the pertinent directory is required to create a file. All writing
done by admin is to a temporary file, which has the name x.filename.
Only after successful execution of the required action is the original
file, if there is one, deleted and the x-file is renamed. 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 mode 444. The mode of the SCCS files
ensures that modifications can only be made using the SCCS commands.
admin also makes use of a transient lock file, called z.filename, to
prevent simultaneous updates to the SCCS file by different users. See
get(1) for further information.
NOTES
If it is necessary to patch an SCCS file for any reason, the mode may
be changed to 644 by the owner to allow a text editor to be used. This
must be followed by a call to admin -z to generate a proper check-sum.
admin -h should be called to ensure the SCCS file is valid.
LOCALE
The language of the message texts is governed by the environment vari-
able LCALL, LCMESSAGES or LANG.
When the default is set, the system behaves as if it were not interna-
tionalized, i.e. the message texts are in English. You must change one
of these variables in order to change the language of the message
texts.
Detailed information on the dependencies of the environment variables
and on internationalization in general can be found in the manual
"Programmer's Guide: Internationalization - Localization". Refer also
to environ(5) for information on setting the user environment.
FILES
x-file see delta(1)
z-file see delta(1)
Page 5 Reliant UNIX 5.44 Printed 11/98
admin(1) admin(1)
SEE ALSO
bdiff(1), ed(1), delta(1), get(1), help(1), prs(1), what(1),
sccsfile(4).
Page 6 Reliant UNIX 5.44 Printed 11/98