NAME¶

sccs-admin, admin - create and administer SCCS history files

SYNOPSIS¶

/usr/ccs/bin/admin [-bhknoz] [-a username | groupid]...
[-d flag] ... [-e username | groupid ]...
[-f flag[value]] ... [-i[filename]] [-m mr-list]
[-q[nsedelim]] [-w%W%-string]
[-rrelease] [-t[description-file]] [-y[comment]]
[-Xextended-options] [-Nbulk-spec] s.filename...

DESCRIPTION¶

The admin command creates or modifies the flags and other parameters of SCCS history files. Filenames of SCCS history files begin with the `s.' prefix, and are referred to as s.files, or ``history'' files.

The named s.file is created if it does not exist already. Its parameters are initialized or modified according to the options you specify. Parameters not specified are given default values when the file is initialized, otherwise they remain unchanged.

If a directory name is used in place of the s.filename argument, the admin command applies to all s.files in that directory. Unreadable s.files produce an error. The use of `−' as the s.filename argument indicates that the names of files are to be read from the standard input, one s.file per line.

OPTIONS¶

The following options are supported:

-a username | groupid

Adds a user name, or a numerical group ID, to the list of users who may check deltas in or out. If the list is empty, any user is allowed to do so.

-b

Forces encoding of binary data. Files that contain ASCII NUL, that contain lines that start with the the SCCS control character SOH(ASCII 001) or that do not end with a NEWLINE, are recognized as binary data files when using the SCCSv4 history file format. The contents of such files are stored in the history file in encoded form. See uuencode(1C) for details about the encoding. This option is normally used in conjunction with -i to force admin to encode initial versions not recognized as containing binary data.

The new SCCSv6 history file format permits having lines that start with the SCCS control character SOH(ASCII 001) and files that do not end with a NEWLINE, enforcing the binary file format only if a file contains ASCII NUL characters.

-d flag

Deletes the indicated flag from the SCCS file. The -d option may be specified only for existing s.files. See -f for the list of recognized flags.

-e username | groupid

Erases a user name or group ID from the list of users allowed to make deltas.

-f flag [value]

Sets the indicated flag to the (optional) value specified. The following flags are recognized:

-h

Checks the structure of an existing s.file (see sccsfile(5)), and compares a newly computed check-sum with one stored in the first line of that file. -h inhibits writing on the file and so nullifies the effect of any other options.

-i[filename]

Initializes the history file with text from the indicated file. This text constitutes the initial delta, or set of checked-in changes. If filename is omitted, the initial text is obtained from the standard input. Omitting the -i option altogether creates an empty s.file. You can only initialize one s.file with text using -i unless you use the bulk option -N. The -i option implies the -n option.

If you like to initialize more than one s.file in one call, use the -N option and specify -i. (-i followed by a dot).

-k

Suppresses expansion of ID keywords when admin(1) is doing an implicit get(1) operation because -N+... was specified.

This option is a SCHILY extension that does not exist in historic sccs implementations.

-m mr-list

Inserts the indicated Modification Request (MR) numbers into the commentary for the initial version. When specifying more than one MR number on the command line, mr-list takes the form of a quoted, space-separated list. A warning results if the v flag is not set or the MR validation fails.

-Nbulk-spec

Creates a bulk of new SCCS history files. This option allows one to do an efficient mass creation of SCCS history files and to initialize the SCCS history files from named files that are the respective counterpart to the actual SCCS history file.

The bulk-spec parameter is composed from an optional list of flag parameters followed by an optional path specifier.

The following flag types are supported:

-n

Creates a new SCCS history file.

-o

Use the original time of the existing file for the delta time when creating a new s.file. In NSE mode, this is the default behavior. If admin(1) is doing an implicit get(1) operation because -N+... was specified, the new g-file is also set to the original file date.

This option is a SCHILY extension that does not exist in historic sccs implementations.

-q[nsedelim]

Enable NSE mode. If NSE mode is enabled, several NSE related extensions may be used. In this release, the value of nsedelim is ignored.

In NSE mode, admin behaves as if the -o option was specified and never issues a warning about missing id keywords.

This option is an undocumented SUN extension that does not exist in historic sccs implementations.

-rrelease

Specifies the release for the initial delta. -r may be used only in conjunction with -i. The initial delta is inserted into release 1 if this option is omitted. The level of the initial delta is always 1. Initial deltas are named 1.1 by default.

-t[description-file]

Inserts descriptive text from the file description-file. When -t is used in conjunction with -n, or -i to initialize a new s.file, the description-file must be supplied. When modifying the description for an existing file: a -t option without a description-file removes the descriptive text, if any; a -t option with a description-file replaces the existing text.

-w%W%-string

The %W%-string is used as a replacement for the %W% keyword when admin(1) is doing an implicit get(1) operation because -N+... was specified. If -w was not specified, %W% is expanded to %Z%%M% %I%, otherwise the argument from -w is used.

This option is an undocumented SUN extension that does not exist in historic sccs implementations.

-Xextended-options

Specify extended options. The argument extended-options may be a comma separated list of extended option names.

The following extended options are supported, they may be abbreviated as long ad the abbreviation is still unique. Options with parameter may not be abbreviated.

-V

-version

--version

Prints the admin version number string and exists.

This option is a SCHILY extension that does not exist in historic sccs implementations.

-V4

When used together with -i or -n, admin(1) will create a SCCS v4 history file instead of the default, that may be SCCS v6.

-V6

When used together with -i or -n, admin(1) will create a SCCS v6 history file instead of a SCCS v4 history file.

SCCS v6 history files are the default in case that a directory projecthome/.sccs/ has been created before and correctly populated and admin(1) has been called with the -N option to select the new mode.

SCCS v6 history files are not understood by historic SCCS implementations. See sccsfile(5) for more information on the new features.

This option is a SCHILY extension that does not exist in historic sccs implementations.

-y[comment]

Inserts the indicated comment in the ``Comments:'' field for the initial delta. Valid only in conjunction with -i or -n. If -y option is omitted, a default comment line is inserted that notes the date and time the history file was created.

-z

Recomputes the file check-sum and stores it in the first line of the s.file. Caution: It is important to verify the contents of the history file (see sccs-val(1), and the print subcommand in sccs(1)), since using -z on a truly corrupted file may prevent detection of the error.

EXAMPLES¶

Example 1 Preventing SCCS keyword expansion

In the following example, 10 lines of file will be scanned and only the W,Y,X keywords will be interpreted:

example% 

sccs admin -fs10 file
example% 

sccs admin -fyW,Y,X file
example% 

get file

Example 2 Preventing SCCS keyword expansion and suppressing the `No id keywords (cm7)' warning

In the following example, no keywords will be interpreted and no warning will be generated:

example% 

sccs admin -fy file
example% 

get file

Example 3 Mass entering files with auto-initialization

In the following example, all files in the usr/src tree will be put under SCCS and the SCCS history files will be put into SCCS sub directories:

example% 

find usr/src -type f | sccs admin -NSCCS -i.

The original g-files will be left untouched.

Example 4 Mass entering files with auto-initialization

In the following example, all files in the usr/src tree will be put under SCCS and the SCCS history files will be put into SCCS sub directories. Each original file will be renamed to ,file after the file has been successfully put under SCCS control:

example% 

find usr/src -type f | sccs admin -N,SCCS -i.

Example 5 Entering all files in a directory with auto-initialization

In the following example, all files in the current directory will be put under SCCS and the SCCS history files will be put into the SCCS sub directory:

example% 

sccs admin -NSCCS -i. .

The original g-files will be left untouched.

ENVIRONMENT VARIABLES¶

See environ(7) for descriptions of the following environment variables that affect the execution of admin(1): LANG, LC_ALL, LC_COLLATE, LC_CTYPE, LC_MESSAGES, and NLSPATH.

SCCS_NO_HELP

If set, admin(1) will not automatically call help(1) with the SCCS error code in order to print a more helpful error message. Scripts that depend on the exact error messages of SCCS commands should set the environment variable SCCS_NO_HELP and set LC_ALL=C.

SCCS_V6

If set, admin(1) by default creates new history files with SCCS v6 encoding.

EXIT STATUS¶

The following exit values are returned:

0

Successful completion.

1

An error occurred.

FILES¶

e.file

temporary file to hold an uuencoded version of the g-file in case of an encoded history file

s.file

SCCS history file, see sccsfile(5).

SCCS/s.file

history file in SCCS subdirectory

x.file

temporary copy of the s.file; renamed to the s.file after completion.

z.file

temporary lock file contains the binary process id in host byte order followed by the host name

dump.core

If the file dump.core exists in the current directory and a fatal signal is received, a coredump is initiated via abort(3).

ATTRIBUTES¶

See attributes(7) for descriptions of the following attributes:

SEE ALSO¶

sccs(1), sccs-add(1), sccs-branch(1), sccs-cdc(1), sccs-check(1), sccs-clean(1), sccs-comb(1), sccs-commit(1), sccs-create(1), sccs-cvt(1), sccs-deledit(1), sccs-delget(1), sccs-delta(1), sccs-diffs(1), sccs-edit(1), sccs-editor(1), sccs-enter(1), sccs-fix(1), sccs-get(1), sccs-help(1), sccs-histfile(1), sccs-info(1), sccs-init(1), sccs-istext(1), sccs-ldiffs(1), sccs-log(1), sccs-print(1), sccs-prs(1), sccs-prt(1), sccs-rcs2sccs(1), sccs-remove(1), sccs-rename(1), sccs-rmdel(1), sccs-root(1), sccs-sact(1), sccs-sccsdiff(1), sccs-status(1), sccs-tell(1), sccs-unedit(1), sccs-unget(1), sccs-val(1), bdiff(1), diff(1), what(1), sccschangeset(5), sccsfile(5), attributes(7), environ(7), standards(7).

DIAGNOSTICS¶

Use the SCCS help command for explanations (see sccs-help(1)).

WARNINGS¶

The last component of all SCCS filenames must have the `s.' prefix. New SCCS files are given mode 444 (see chmod(1)). All writing done by admin is to a temporary file with an x. prefix, created with mode 444 for a new SCCS file, or with the same mode as an existing SCCS file. After successful execution of admin, the existing s.file is removed and replaced with the x.file. This ensures that changes are made to the SCCS file only when no errors have occurred.

It is recommended that directories containing SCCS files have permission mode 755, and that the s.files themselves have mode 444. The mode for directories allows only the owner to modify the SCCS files contained in the directories, while the mode of the s.files prevents all modifications except those performed using 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 to allow use of a text editor. However, extreme care must be taken when doing this. The edited file should always be processed by an `admin -h' command to check for corruption, followed by an `admin -z' command to generate a proper check-sum. Another `admin -h' command is recommended to ensure that the resulting s.file is valid.

admin uses a temporary lock file, starting with the `z.' prefix, to prevent simultaneous updates to the s.file. See sccs-get(1) for further information about the `z.file'.

BUGS¶

None currently known.

Mail bugs and suggestions to schilytools@mlists.in-berlin.de or open a ticket at https://codeberg.org/schilytools/schilytools/issues.

The mailing list archive may be found at:

https://mlists.in-berlin.de/mailman/listinfo/schilytools-mlists.in-berlin.de.

AUTHORS¶

The SCCS suite was originally written by Marc J. Rochkind at Bell Labs in 1972. Release 4.0 of SCCS, introducing new versions of the programs admin(1), get(1), prt(1), and delta(1) was published on February 18, 1977; it introduced the new text based SCCS v4 history file format (previous SCCS releases used a binary history file format). The SCCS suite was later maintained by various people at AT&T and Sun Microsystems. Since 2006, the SCCS suite has been maintained by Joerg Schilling and the schilytools project authors.

SOURCE DOWNLOAD¶

The source code for sccs is included in the schilytools project and may be retrieved from the schilytools project at Codeberg at

https://codeberg.org/schilytools/schilytools.

The download directory is

https://codeberg.org/schilytools/schilytools/releases.