admin(1) admin(1)
NAME [Toc] [Back]
admin - create and administer SCCS files
SYNOPSIS [Toc] [Back]
admin -i[name] [-n] [-b] [-a login] ... [-d flag[flag-val]] ...
[-f flag[flag-val]] ... [-m mrlist] ... [-r rel] [-t[name]]
[-y[comment]] file ...
admin -n [-a login] ... [-d flag[flag-val]] ...
[-f flag[flag-val]] ... [-m mrlist] ... [-t[name]]
[-y[comment]] file ...
admin [-a login] ... [-e login] ... [-d flag[flag-val]] ...
[-m mrlist] ... [-r rel] [-t[name]] file ...
admin -h file ...
admin -z file ...
DESCRIPTION [Toc] [Back]
The admin command is used to create new SCCS files and change the
parameters of existing ones. Arguments to admin, which may appear in
any order, ( unless -- is specified as an argument, in which case all
arguments after -- are treated as files ) consist of option arguments,
beginning 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
option arguments. Parameters not initialized by an option argument
are assigned a default value. If a named file does exist, parameters
corresponding to specified option arguments are changed, and other
parameters are left unaltered.
If directory is named instead of file, admin acts on each file in
directory, except that non-SCCS files (the last component of the path
name does not begin with s.) and unreadable files are silently
ignored. If a name of - is given, the standard input is read, and
each line of the standard input is assumed to be the name of an SCCS
file to be processed. Again, non-SCCS files and unreadable files are
silently ignored.
The admin option arguments apply independently to all named files,
whether one file or many. In the following discussion, each option is
explained as if only one file is specified, although they affect
single or multiple files identically.
Options [Toc] [Back]
The admin command supports the following options and command-line
arguments:
-n This option indicates that a new SCCS file is to
be created.
Hewlett-Packard Company - 1 - HP-UX 11i Version 2: Sep 2004
admin(1) admin(1)
-i[name] The name of a file from which the contents for a
new SCCS file is to be taken. (if name is a
binary file, then you must specify the -b option)
The contents constitutes the first delta of the
file (see the -r option for the 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, the SCCS
file is created with an empty initial delta. Only
one SCCS file can be created by an admin command
on which the -i option is supplied. 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.
-b Encode the contents of name, specified to the -i
option. This keyletter must be used if name is a
binary file; otherwise, a binary file will not be
handled properly by SCCS commands.
-r rel The release (rel) into which the initial delta is
inserted. This option can 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 are also used), the descriptive
text file name must also be supplied. In the case
of existing SCCS files:
+ A -t option without a file name causes removal
of descriptive text (if any) currently in the
SCCS file.
+ A -t option with a file name causes text (if
any) in the named file to replace the
descriptive text (if any) currently in the SCCS
file.
-f flag This option specifies a flag, and possibly a value
for the flag, to be placed in the SCCS file.
Several -f options can be supplied on a single
admin command line. The allowable flags and their
values are:
Hewlett-Packard Company - 2 - HP-UX 11i Version 2: Sep 2004
admin(1) admin(1)
b Allows use of the -b option on a get
command (see get(1)) to create branch
deltas.
cceil The highest release (i.e., "ceiling"), a
number 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 (i.e., "floor"), a
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.
dSID The default delta number SID to be used
by a get command (see get(1)).
istr Causes the message:
No id keywords (cm7) [Toc] [Back]
issued by get or delta to be treated as
a fatal error (see delta(1)). 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, but must
not contain embedded newlines.
j Allows concurrent get commands for
editing on the same SID of an SCCS file.
This allows multiple concurrent updates
to the same version of the SCCS file.
Only one user can perform concurrent
edits. Access by multiple users is
usually accomplished by using a common
login or a set user ID program (see
chmod(1) and exec(2)).
llist A list of releases to which deltas can
no longer be made. (A get -e against
one of these locked releases fails).
The list has the following syntax:
Hewlett-Packard Company - 3 - HP-UX 11i Version 2: Sep 2004
admin(1) admin(1)
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. Omitting any
list is equivalent to a.
n Causes delta to create a null delta in
each of those releases being skipped (if
any) when a delta is made in a new
release (such as when making delta 5.1
after delta 2.7, release 3 and release 4
are skipped). These null deltas serve
as anchor points so that branch deltas
can be created from them later. 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.
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.
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 a (MR) number
validity checking program (see
delta(1)). (If this flag is set when
creating an SCCS file, the m option must
also be used even if its value is null).
x Causes get to create files with execute
permissions.
-d flag Causes removal (deletion) of the specified flag
from an SCCS file. The -d option can be specified
Hewlett-Packard Company - 4 - HP-UX 11i Version 2: Sep 2004
admin(1) admin(1)
only when processing existing SCCS files. Several
-d options can be supplied on a single admin
command line. 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.
-a login A login name, or numerical HP-UX group ID, to be
added to the list of users allowed to make deltas
(changes) to the SCCS file. A group ID is
equivalent to specifying all login names common to
that group ID. Several a options 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,
anyone can add deltas. A login or group ID
preceded by a ! denies 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
(changes) to the SCCS file. Specifying a group ID
is equivalent to specifying all login names common
to that group ID. Several e options can be used
on a single admin command line.
-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(1). Omission of 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).
-m mrlist 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(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).
Diagnostic messages occur if the v flag is not set
or (MR) validation fails.
-h Causes admin to check the structure of the SCCS
file (see sccsfile(4)), and to compare a newly
computed checksum (the sum of all of the
Hewlett-Packard Company - 5 - HP-UX 11i Version 2: Sep 2004
admin(1) admin(1)
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 option inhibits writing on the file, thus
canceling the effect of any other options
supplied, and therefore is 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 option on a truly corrupted
file can prevent future detection of the
corruption.
Access Control Lists (ACLs) [Toc] [Back]
Do not add optional ACL entries to SCCS files. SCCS removes them,
possibly causing unexpected and undesirable access modes.
EXTERNAL INFLUENCES [Toc] [Back]
Environment Variables
LC_CTYPE determines the interpretation of text as single- and/or
multi-byte characters.
LC_MESSAGES determines the language in which messages are displayed.
If LC_CTYPE or LC_MESSAGES is not specified in the environment or is
set to the empty string, the value of LANG is used as a default for
each unspecified or empty variable. If LANG is not specified or is
set to the empty string, a default of C (see lang(5)) is used instead
of LANG. If any internationalization variable contains an invalid
setting, admin behaves as if all internationalization variables are
set to C. See environ(5).
International Code Set Support [Toc] [Back]
Single-byte and multi-byte character code sets are supported.
DIAGNOSTICS [Toc] [Back]
Use sccshelp(1) for explanations.
WARNINGS [Toc] [Back]
Number of lines in a SCCS file cannot exceed 99,999 lines. Each line
can be of BUFSIZ-3 characters in non-XPG4 environment and LINE_MAX-3
in XPG4 environment, including the newline.
FILES [Toc] [Back]
The last component of all SCCS file 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.
Hewlett-Packard Company - 6 - HP-UX 11i Version 2: Sep 2004
admin(1) admin(1)
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 to 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 any given
directory allows only the owner to modify SCCS files contained in that
directory. 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, thus allowing the use of vi
or any other suitable editor. 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.
admin 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(1) for further information.
SEE ALSO [Toc] [Back]
delta(1), ed(1), get(1), sccshelp(1), prs(1), what(1), sccsfile(4),
acl(5).
STANDARDS CONFORMANCE [Toc] [Back]
admin: SVID2, SVID3, XPG2, XPG3, XPG4
Hewlett-Packard Company - 7 - HP-UX 11i Version 2: Sep 2004 [ Back ] |
