admin(1)

NAME

admin − SCCS file administrator

SYNTAX

admin [−n] [−i[name]] [−rrel] [−t[name]] [−fflag[flag-val]] [−dflag[flag-val]] [−alogin] [−elogin] [−m[list]] [−y[comment]] [−h] [−z] files

DESCRIPTION

The admin command is used to create new SCCS files and to change parameters of existing ones. Arguments to admin, which may appear in any order, consist of keyletter arguments, which begin with −, and named files (note that 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 the specified keyletter arguments. Parameters not initialized by a keyletter argument are assigned a default value. If a named file does exist, parameters corresponding to specified keyletter arguments 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 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.

OPTIONS

Each keyletter argument is explained as though only one named file is to be processed, because the effects of the arguments apply independently to each named file. The list of arguments is as follows:

−n This keyletter indicates that a new SCCS file is to be created.
. RE

−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 the −r keyletter for the delta numbering scheme). If the i keyletter 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 keyletter is omitted, then the SCCS file is created empty. Only one SCCS file can be created by an admin command in which the i keyletter is supplied. Using a single admin command to create two or more SCCS files requires that they be created empty (no −i keyletter). Note that the −i keyletter implies the −n keyletter.
. RE

−rrel The release 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.
. RE

−t[name] The name of a file from which descriptive text for the SCCS file is to be taken. If the −t keyletter is used and admin is creating a new SCCS file (the −n and/or −i keyletters are also used), the descriptive text file name must also be supplied. In the case of existing SCCS files: (1) a −t keyletter without a file name causes removal of descriptive text (if any) currently in the SCCS file; and (2) a −t keyletter with a file name causes text (if any) in the named file to replace the descriptive text (if any) currently in the SCCS file.
. RE

−fflag This keyletter specifies a flag, and, possibly, a value for the flag, to be placed in the SCCS file. Several f keyletters can be supplied on a single admin command line. The allowable flags and their values are:

. RE

b Allows use of the −b keyletter on a get() command to create branch deltas.
. RE

cceil The highest release (“ceiling”), a positive number no higher than 9999, which may be retrieved by a get() command for editing. The default value for an unspecified c flag is 9999.
. RE

ffloor The lowest release (“floor”), a positive number greater than 0 but less than 9999, which may be retrieved by a get() command for editing. The default value for an unspecified f flag is 1.
. RE

dSID The default delta number (SID) to be used by a get() command.
. RE

i Causes the "No id keywords (ge6)" message issued by get() or delta() 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 are found in the text retrieved or stored in the SCCS file. For further information, see get(.).
. RE

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.
. RE

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:
. RE

<list> ::= <range> | <list> , <range>
<range> ::=RELEASE NUMBER | a
. RE

The character a in the list is equivalent to specifying all releases for the named SCCS file.
. RE

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. 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 can 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.
. RE

qtext User definable text substituted for all occurrences of the %Q% keyword in SCCS file text retrieved by get(1).
. RE

mmod Module name of the SCCS file substituted for all occurrences of the %M% keyword in SCCS file tex retrieved by get(.). If the m flag is not specified, the value assigned is the name of the SCCS file with the leading s. removed.
. RE

ttype Type of module in the SCCS file substituted for all occurrences of %Y% keyword in SCCS file text retrieved by get(1).
. RE

v[pgm] Causes delta() 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. For further information, see delta(.). (If this flag is set when creating an SCCS file, the m keyletter must also be used even if its value is null).

. RE

−dflag Causes deletion of the specified flag from an SCCS file. The −d keyletter can be specified only when processing existing SCCS files. Several −d keyletters can be supplied on a single admin command. See the −f keyletter for allowable flag names.
. RE

−llist A list of releases to be unlocked. See the −f keyletter for a description of the l flag and the syntax of a list.
. RE

−alogin A login name or numerical ULTRIX System group ID to be added to the list of users which can 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 can be used on a single admin command line. As many logins or numerical group IDs as desired can be on the list simultaneously. If the list of users is empty, then anyone can add deltas.
. RE

−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 keyletters can be used on a single admin command line.
. RE

−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 in the form: date and time created YY/MM/DD HH:MM:SS by login The −y keyletter is valid only if the −i or −n keyletters are specified.
. RE

−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(.). 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.
. RE

−h Causes admin to check the structure of the SCCS file and to 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. Appropriate error diagnostics are produced. For further information, see sccsfile(.).
. RE

This keyletter inhibits writing on the file, so that it nullifies the effect of any other keyletters supplied. It is, therefore, only meaningful when processing existing files.
. RE

−z The SCCS file check-sum is recomputed and stored in the first line of the SCCS file (see −h, above).
. RE

Note that use of this keyletter on a truly corrupted file may prevent future detection of the corruption.

DIAGNOSTICS

Use sccshelp(1) for explanations.

FILES

The last component of all SCCS file names are of the form s.file-name. New SCCS files are given mode 444. For further information, see chmod(.). 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.file-name, 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. For further information, see get(.). 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.

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 ed(.).

NOTE

Care must be taken that correct commands are used when patching an SCCS file, otherwise further corruption of the file can occur.

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. Another admin−h is recommended to ensure the SCCS file is valid.

The admin command also makes use of a transient lock file (called z.file-name), which is used to prevent simultaneous updates to the SCCS file by different users. For further information, see get(.).

Museum

Related Articles