ADMIN(1) BSD ADMIN(1)
NAME
admin - create and administer SCCS files
SYNOPSIS
admin [ options ] file ...
DESCRIPTION
The admin command creates new source code control system (SCCS) files and
changes the parameters of existing ones. You can specify several
different options (in any order) along with named files. An s followed
by a period, must prefix all SCCS filenames (for example, s.file1).
If a named file does not exist, admin creates it. It then initializes
the file's parameters according to specified options. Parameters not
initialized by a valid option, discussed below, are assigned a default
value. If a named file does exist, admin changes the file's parameters
that correspond to specified options; other parameters are left as is.
If you have named a directory in the command line, admin behaves as
though each file in the directory were a named file, except that it
silently ignores non-SCCS and unreadable files. If you give a dash (-)
in place of the filename, admin reads the standard input, taking each
line to be the name of an SCCS file to be processed. Again, it silently
ignores non-SCCS and unreadable files.
OPTIONS
Each option below assumes that only one named file is to be processed,
since the effects of the arguments apply independently to each named
file. On options beginning with -f and followed by an argument, the
specified flag (and value, if applicable) is placed in the SCCS file.
You can supply several of these -f options on a single admin command
line.
-n Create a new SCCS file from the contents of the file specified.
-i[name] Specify name as the name of the file from which the text for a
new SCCS file is to be taken. The text comprises the first
delta of the specified file. If you omit name, admin gets the
text for the SCCS file by reading the standard input until it
encounters an end-of-file. This option allows you to create
only one SCCS file at a time. Without it, the SCCS file is
created empty.
-rrel Insert the initial delta into the specified release (the
default is release 1). You can use this option only if the -i
option is also present. Note that the default level of initial
deltas is always 1; thus, the naming of initial deltas defaults
to 1.1.
-t[name] Use the name of the file specified for descriptive text for the
SCCS file. If you use this option with -n and/or -i, you must
also supply the descriptive text filename. For existing SCCS
files, using this option without specifying a filename removes
any descriptive text from the SCCS file. If you specify a
filename, any descriptive text in the SCCS file is replaced by
existing text in the named file.
-fb Allow use of the -b keyletter on a get(1) command to create
branch deltas.
-fcceil Specify the highest release ("ceiling") that may be retrieved
by a get(1) command for editing. The number should be less
than or equal to 9999. The default is 9999.
-fffloor Specify the lowest release ("floor") that may be retrieved by a
get(1) command for editing. The number should be greater than
zero but less than 9999. The default is 1.
-fdSID Indicate the default delta number (SID) to be used by a get(1)
command.
-fi[str] Treat the "No id keywords (ge6)" message issued by get(1) or
delta(1) 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 are found in the text retrieved or
stored in the SCCS file. If you supply a value, the keywords
must be identical to the given string; however, the string must
contain a keyword, and must not contain embedded newlines.
-fj Allow concurrent get(1) commands for editing on the same (SID)
of an SCCS file. This allows multiple concurrent updates to
the same version of the SCCS file.
-fllist Specify 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:
<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.
-fn Force delta(1) to create a "null" delta in any release being
skipped when a delta is made in a new release (for example, 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.
-fqtext Substitute user-definable text for all occurrences of the %Q%
keyword in SCCS file text retrieved by get(1).
-fmmod Substitute the module name of the SCCS file for all occurrences
of the %M% keyword in SCCS file text retrieved by get(1). If
you do not specify the -m option, the value assigned is the
name of the SCCS file with the leading s. removed.
-fttype Substitute the type of module in the SCCS file for all
occurrences of %Y% keyword in SCCS file text retrieved by
get(1).
-fv[pgm] Force delta(1) 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.
(If this flag is set when creating an SCCS file, you must also
use the -m option, even if its value is null.)
-dflag Remove (delete) the specified flag from an SCCS file. You can
specify the -d option only when processing existing SCCS files.
You can supply several -d options on a single admin command.
See the options beginning with a -f (for example, -fb, -fj) for
allowable flag names.
-llist Specify a list of releases to be "unlocked." See the -fllist
option for a description of the l flag and the syntax of a
list.
-alogin Indicate a login name, or numerical UNIX system group ID, to be
added to the list of users that can make deltas (changes) to
the SCCS file. A group ID is equivalent to specifying all
login names common to that group ID. You can specify several
of these options on a single admin command line. You can put
as many logins, or numerical group IDs, as you want on the list
simultaneously. If the list of users is empty, anyone can make
changes. A user with a login or group ID preceded by an
exclamation point (!) is not allowed to make changes.
-elogin Indicate 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. You can specify several
-e options on a single admin command line.
-y[comment]
Insert the comment text into the SCCS file as a comment for the
initial delta in a manner identical to that of delta(1).
Omitting the -y option results in a default comment line being
inserted in the form
date and time created YY/MM/DD HH:MM:SS by login
The -y option is valid only if you specify the -i and/or -n
options (that is, if you are creating a new SCCS file).
-m[mrlist]
Insert the list of MR numbers into the SCCS file as the reason
for creating the initial delta in a manner identical to
delta(1). 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 occur if the v flag is not
set or MR validation fails. See the -fv option described
above.
-h Check the structure of the SCCS file and compare a newly
computed check-sum (the sum of all the characters in the SCCS
file except those in the first line) with the check-sum that is
stored in the first line of the SCCS file. This option
produces appropriate error diagnostics. It also inhibits
writing on the file, so that it nullifies the effect of any
other options supplied. Therefore, it is meaningful only when
processing existing files.
-z Recompute the SCCS file check-sum and store it in the first
line of the SCCS file (refer to the -h option above). Note
that using this option on a truly corrupted file may prevent
future detection of the corruption.
EXAMPLE
To create a new SCCS file (called sccsfile1) from file1, type the
following:
# admin -ifile1 s.sccsfile1
BUGS
Directories containing SCCS files should be 755 mode, so that only the
owner can modify SCCS contained in the directories. The mode of SCCS
files themselves should be 444, to prevent modifications except by SCCS
commands.
If you have to patch an SCCS file, the owner must change the file's mode
to 644, to allow use of an editor. Always process the edited file by an
admin -h to check for corruption, followed by an admin -z to generate a
proper check-sum. You should then specify another admin -h to ensure
that the SCCS file is valid.
DIAGNOSTICS
Use help(1) for explanations.
SEE ALSO
delta(1), get(1), help(1), prs(1), sccs(1), what(1), sccsfile (4)