admin(1) DG/UX 5.4.2 admin(1)
NAME
admin - create and administer SCCS files
SYNOPSIS
admin [-n] [ -i[name] ] [ -rrel ] [ -t[name] ] [ -fflag[flag-val] ]
[ -dflag[flag-val] ] [ -llist ] [ -alogin ] [ -elogin ]
[ -m[mrlist] ] [ -y[comment] ] [-h] [-z] files
DESCRIPTION
Admin creates new SCCS files and changes parameters of existing ones.
SCCS file names must begin with the characters "s.". If a named file
does not exist, it is created, and its parameters are initialized
according to any options specified. Parameters not initialized are
assigned a default value. If a named file does exist, parameters
corresponding to specified options are changed, and other parameters
are left as they are.
If a directory is named, admin behaves as though each file in the
directory were specified as a named file, except that non-SCCS files
(last component of the path name does not begin with s.) and
unreadable files are ignored. If a name of - 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, non-SCCS files and
unreadable files are 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 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 for delta numbering scheme). If the i option
is used, but the file name 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 line including the i option. Using a single
admin to create two or more SCCS files requires that they be
created empty (no -i option). Note that the -i option
implies the -n option.
-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).
-t[name] The name of a file from which descriptive text for the SCCS
file is to be taken. If the -t option is used and admin is
creating a new SCCS file (the -n and/or -i options also
used), the descriptive text file name must also be supplied.
In the case of existing SCCS files: (1) a -t option without
Licensed material--property of copyright holder(s) 1
admin(1) DG/UX 5.4.2 admin(1)
a file name removes descriptive text (if any) currently in
the SCCS file, and (2) a -t option with a file name
substitutes text (if any) in the named file for the
descriptive text (if any) currently in the SCCS file.
-fflag 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(1) command to
create branch deltas.
cceil The highest release (ceiling), a number less than or
equal to 9999, that can be retrieved by a get(1)
command for editing. The default value for an
unspecified c flag is 9999.
ffloor The lowest release (floor), a number greater than 0
but less than 9999, that can be retrieved by a get(1)
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(1)
command.
i[str] Treats the "No id keywords (ge6)" message issued by
get(1) or delta(1) 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(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; however, the string must contain a
keyword and must not contain embedded newlines.
j Allows 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.
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:
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 Makes delta(1) create a "null" delta in any releases
being skipped when a delta is made in a new release
(e.g., in making delta 5.1 after delta 2.7, releases
Licensed material--property of copyright holder(s) 2
admin(1) DG/UX 5.4.2 admin(1)
3 and 4 are skipped). These null deltas serve as
anchor points so that branch deltas may later be
created from them. If you don't use this flag,
skipped releases won't show up in the SCCS file, thus
preventing branch deltas from being created from them
in the future.
qtext User definable text substituted for all occurrences
of the %Q% keyword in SCCS file text retrieved by
get(1).
mmod Module name of the SCCS file substituted for all
occurrences of the %M% keyword in SCCS file text
retrieved by get(1). 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 %Y% keyword in SCCS file text
retrieved by get(1).
v[pgm] Makes delta(1) 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(1)). (If you
set this flag when creating an SCCS file, you must
also use the m option, even if its value is null).
-dflag Removes (deletes) the specified flag from an SCCS file. You
may specify this option 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.
-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 group ID, to be added to the list
of users who may make deltas (changes) to the SCCS file. A
group ID is equivalent to 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. To deny the
privilege to a login or group ID, put a ! in front of it;
e.g., -a!fred will assert that fred may not 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.
-m[mrlist]
The list of Modification Request (MR) numbers is inserted
Licensed material--property of copyright holder(s) 3
admin(1) DG/UX 5.4.2 admin(1)
into the SCCS file as the reason for creating the initial
delta, just as for 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 will occur
if the v flag is not set or MR validation fails.
-ycomment
The comment text is inserted into the SCCS file as a comment
for the initial delta, just as for 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 the -i and/or -n options are
specified (i.e., a new SCCS file is being created).
-h Makes admin check the structure of the SCCS file (see
sccsfile(4)), and compare the sum of all the characters in
the SCCS file, except those in the first line, with the
check-sum stored in the first line of the SCCS file.
Appropriate error diagnostics are produced.
This option inhibits writing on the file, so that it
nullifies the effect of any other options supplied. It is
meaningful only when processing existing files.
-z The SCCS file check-sum is recomputed and stored in the
first line of the SCCS file (see -h, above).
Using this option on a truly corrupted file may prevent
future detection of the corruption.
International Features
Keyletter Arguments:
-i[name]
Characters from supplementary code sets can be used for the
name of the file from which the text is to be taken. The file
may also include characters from supplementary code sets.
-t[name]
Characters from supplementary code sets can be used for the
name of the file from which the text is to be taken. The file
may also include characters from supplementary code sets.
-fflag
qtext Characters from supplementary code sets can be used for
the substitution text text.
mmod Characters from supplementary code sets can be used for
the module name mod.
-y[comment]
The comment text including characters from supplementary code
Licensed material--property of copyright holder(s) 4
admin(1) DG/UX 5.4.2 admin(1)
sets can be inserted into the SCCS file as a comment.
Characters from supplementary code sets can be used for for SCCS file
names, files. However, they must begin with the ASCII characters s..
SCCS files may also include characters from supplementary code sets.
EXAMPLES
admin -ifile1 s.file1
This command will take a file called 'file1' and create an SCCS file
named 's.file1'. NOTE: If you receive a message 'No id keywords
(cm7)' do not be alarmed, it is a warning message and should be
ignored for now.
admin -ifile2 -r2.02 s.file2
This command will take a file called 'file2' and create an SCCS file
named 's.file2', which will have a release of 2.02. Once again if
you should receive message 'No id keywords (cm7)' do not be alarmed,
it is just a warning message and should be ignored for now.
admin -ajohn s.file3
This command allows user 'john' to make deltas (changes) to the SCCS
file 's.file3', while the command admin -ejohn s.file3 revokes the
privilege for john to change the file 's.file3'.
FILES
The last component of all SCCS path names must be of the form
s.filename. New SCCS files are given mode 444 (see chmod(1)). Write
permission in the pertinent directory is required to create a file.
All writing done by admin is to a temporary x-file, called
x.filename, (see get(1)), created with mode 444 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.
Directories containing SCCS files should have access mode 755 and
SCCS files themselves should be mode 444. This mode of the
directories lets only the owner modify SCCS files in the directories.
The mode of the SCCS files prevents any modification at all except by
SCCS commands.
If you need to patch an SCCS file for any reason, the mode may be
changed to 644 by the owner allowing use of ed(1). Be careful! The
edited file should always be processed by an admin -h to check for
corruption followed by an admin -z to generate a proper check-sum.
Use another admin -h to ensure that the SCCS file is valid.
Admin also uses a transient lock file (called z.filename), which
prevents simultaneous updates to the SCCS file by different users.
See get(1) for more information.
Licensed material--property of copyright holder(s) 5
admin(1) DG/UX 5.4.2 admin(1)
DIAGNOSTICS
Use help(1) for explanations.
SEE ALSO
delta(1), ed(1), get(1), help(1), prs(1), what(1), sccsfile(4).
Licensed material--property of copyright holder(s) 6