Museum

Home

Lab Overview

Retrotechnology Articles

⇒ Online Manual

Media Vault

Software Library

Restoration Projects

Artifacts Sought

Related Articles

delta(1)

get(1)

prs(1)

what(1)

ed(1)

help(1)

sccsfile(4)



  admin(1)                            CLIX                            admin(1)



  NAME

    admin - Creates and administers SCCS files

  SYNOPSIS

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

  FLAGS

    Each flag 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 flag 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 flag for delta numbering scheme).  If the -i
                  flag is used, but the filename is omitted, the text is
                  obtained by reading stdin until an end-of-file is
                  encountered.  If this flag is omitted, then the SCCS file is
                  created empty.  Only one SCCS file can be created by an
                  admin command on which the -i flag is supplied.  Using a
                  single admin to create two or more SCCS files requires that
                  they be created empty (no -i flag).  Note that the -i flag
                  implies the -n flag.

    -rrel         The release into which the initial delta is inserted.  This
                  flag can be used only if the -i flag is also used.  If the
                  -r flag 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 flag is used and admin is
                  creating a new SCCS file (the -n and/or -i flags also used),
                  the descriptive text filename must also be supplied.  In the
                  case of existing SCCS files:

                  ⊕  A -t flag without a filename causes removal of
                     descriptive text (if any) currently in the SCCS file and

                  ⊕  A -t flag with a filename causes text (if any) in the
                     named file to replace the descriptive text (if any)
                     currently in the SCCS file.

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



  2/94 - Intergraph Corporation                                              1






  admin(1)                            CLIX                            admin(1)



                  b      Allows use of the -b flag on a get command to create
                         branch deltas.

                  cceil  The highest release (in other words ``ceiling''), a
                         number greater than 0 but less than or equal to 9999,
                         which can be retrieved by a get command for editing.
                         The default value for an unspecified c flag is 9999.

                  ffloor The lowest release (in other words, ``floor''), a
                         number greater than 0 but less than 9999, which can
                         be retrieved by a get command for editing.  The
                         default value for an unspecified f flag is1.

                  dSID   The default delta number (SIDs+1) to be used by a
                         get() command.

                  i[str] Causes the No id keywords (get) 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 (see get) 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 no embedded
                         newlines.

                  j      Allows concurrent get commands for editing on the
                         same SIDs+1 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> ::= a

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

                  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.




  2                                              Intergraph Corporation - 2/94






  admin(1)                            CLIX                            admin(1)



                  qtext  User definable text substituted for all occurrences
                         of the Q keyword in SCCS file text retrieved by get.

                  mmod   The module name of the SCCS file substituted for all
                         occurrences of the %M% keyword in SCCS file text
                         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.

                  ttype  The type of module in the SCCS file substituted for
                         all occurrences of Y keyword in SCCS file text
                         retrieved by get.

                  vpgm   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 (see delta).  (If this flag
                         is set when creating a file, the -m flag must also be
                         used even if its value is null).

    -dflag        Causes removal (deletion) of the specified flag from an SCCS
                  file.  The -d flag can be specified only when processing
                  existing SCCS files.  Several -d flags can be supplied on a
                  single admin command.  See the -f flag for allowable flag
                  names.

                  llist   A list of releases to be ``unlocked''.  See the -f
                          flag for a description of the l flag and the syntax
                          of a list.

    -alogin       A login name, or numerical UNIX system group ID, to be added
                  to the list of users who make deltas (changes) to the SCCS
                  file.  A group ID is equivalent to specifying all login
                  names common to that group ID.  Several -a flags 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.  If login or group ID is preceded by a !
                  they are to be denied permission to make 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 flags can
                  be used on a single admin command line.

    -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



  2/94 - Intergraph Corporation                                              3






  admin(1)                            CLIX                            admin(1)



                  value (the name of an MR number validation program).
                  Diagnostics will occur 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 flag 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 flag is valid only if
                  the -i and/or -n flags are specified (in other words, a new
                  SCCS file is being created).

    -h            Causes admin to check the structure of the SCCS file (see
                  sccsfile), 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.  Appropriate error diagnostics are
                  produced.  This flag inhibits writing on the file, so that
                  it nullifies the effect of any other flags 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 flag on a truly corrupted file can prevent future
                  detection of the corruption.

  DESCRIPTION

    The admin command is used to create new SCCS files and change parameters
    of existing ones.  Arguments to admin, which can appear in any order,
    consist of flag arguments, which begin with -, and named files (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 flag arguments.  Parameters not initialized by a flag
    argument are assigned a default value.  If a named file does exist,
    parameters corresponding to specified flag 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 pathname does not begin with s.) and unreadable files are
    silently ignored.  If a name of - is given, stdin is read; each line of
    stdin is taken to be the name of an SCCS file to be processed.  Again,
    non-SCCS files and unreadable files are silently ignored.

    The last component of all SCCS filenames must be of the form s.filename.
    New SCCS files are given mode 444 (see chmod).  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),
    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



  4                                              Intergraph Corporation - 2/94






  admin(1)                            CLIX                            admin(1)



    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 mode 444.  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
    can be changed to 644 by the owner allowing use of ed.  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.  The
    admin command 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 for further information.

  EXAMPLES

    1.  To specify a release number of 3.1 for the first delta of file s.abc:

        admin -ifirst -r3 s.abc


    2.  To specify that text file desc is to be used for the descriptive text
        part of the SCCS file:

        admin -ifirst -tdesc s.abc


    3.  To create a list of users, usernames xyz, wql, and 1234, who are
        allowed to work on (create deltas) file s.abc:

        admin -axyz -awql -a1234 s.abc


  FILES

    g-file           Existed before the execution of delta; removed after
                     completion of delta.

    p-file           Existed before the execution of delta; can exist after
                     completion of delta.

    q-file           Created during the execution of delta; removed after
                     completion of delta.

    x-file           Created during the execution of delta; renamed to SCCS
                     file after completion of delta.



  2/94 - Intergraph Corporation                                              5






  admin(1)                            CLIX                            admin(1)



    z-file           Created during the execution of delta; removed during the
                     execution of delta.

    d-file           Created during the execution of delta; removed after
                     completion of delta.

    /usr/bin/bdiff   Program to compute differences between the ``gotten''
                     file and the g-file.

  DIAGNOSTICS

    Use help for explanations of error messages.

  EXIT VALUES

    The admin command exits with a value of 1 if it encounters a problem.

  RELATED INFORMATION

    Commands: delta(1), get(1), prs(1), what(1), ed(1), help(1)

    Files: sccsfile(4)
































  6                                              Intergraph Corporation - 2/94




Typewritten Software • bear@typewritten.org • Edmonds, WA 98026