1ADMIN(P) POSIX Programmer's Manual ADMIN(P)
2
6 admin - create and administer SCCS files (DEVELOPMENT)
7
9 admin -i[name][-n][-a login][-d flag][-e login][-f flag][-m mrlist]
10 [-r rel][-t[name][-y[comment]] newfile
11 admin -n[-a login][-d flag][-e login][-f flag][-m mrlist][-t[name]]
13 [-y[comment]] newfile ...
14 admin [-a login][-d flag][-m mrlist][-r rel][-t[name]] file ...
16 admin -h file ...
18 admin -z file ...
20
23 The admin utility shall create new SCCS files or change parameters of
24 existing ones. If a named file does not exist, it shall be created, and
25 its parameters shall be initialized according to the specified options.
26 Parameters not initialized by an option shall be assigned a default
27 value. If a named file does exist, parameters corresponding to speci‐
28 fied options shall be changed, and other parameters shall be left as
29 is.
30 All SCCS filenames supplied by the application shall be of the form
32 s.filename. New SCCS files shall be given read-only permission mode.
33 Write permission in the parent directory is required to create a file.
34 All writing done by admin shall be to a temporary x-file, named x.file‐
35 name (see get ) created with read-only mode if admin is creating a new
36 SCCS file, or created with the same mode as that of the SCCS file if
37 the file already exists. After successful execution of admin, the SCCS
38 file shall be removed (if it exists), and the x-file shall be renamed
39 with the name of the SCCS file. This ensures that changes are made to
40 the SCCS file only if no errors occur.
41 The admin utility shall also use a transient lock file (named z.file‐
43 name), which is used to prevent simultaneous updates to the SCCS file;
44 see get .
45
47 The admin utility shall conform to the Base Definitions volume of
48 IEEE Std 1003.1-2001, Section 12.2, Utility Syntax Guidelines, except
49 that the -i, -t, and -y options have optional option-arguments. These
50 optional option-arguments shall not be presented as separate arguments.
51 The following options are supported:
52 -n Create a new SCCS file. When -n is used without -i, the SCCS
54 file shall be created with control information but without any
55 file data.
56 -i[name]
58 Specify the name of a file from which the text for a new SCCS
59 file shall be taken. The text constitutes the first delta of the
60 file (see the -r option for the delta numbering scheme). If the
61 -i option is used, but the name option-argument is omitted, the
62 text shall be obtained by reading the standard input. If this
63 option is omitted, the SCCS file shall be created with control
64 information but without any file data. The -i option implies
65 the -n option.
66 -r SID
68 Specify the SID of the initial delta to be inserted. This SID
69 shall be a trunk SID; that is, the branch and sequence numbers
70 shall be zero or missing. The level number is optional, and
71 defaults to 1.
72 -t[name]
74 Specify the name of a file from which descriptive text for the
75 SCCS file shall be taken. In the case of existing SCCS files
76 (neither -i nor -n is specified):
77 * A -t option without a name option-argument shall cause the
79 removal of descriptive text (if any) currently in the SCCS
80 file.
81 * A -t option with a name option-argument shall cause the text
83 (if any) in the named file to replace the descriptive text
84 (if any) currently in the SCCS file.
85 -f flag
87 Specify a flag, and, possibly, a value for the flag, to be
88 placed in the SCCS file. Several -f options may be supplied on a
89 single admin command line. Implementations shall recognize the
90 following flags and associated values:
91 b
93 Allow use of the -b option on a get command to create branch
94 deltas.
95 cceil
97 Specify the highest release (that is, ceiling), a number less
98 than or equal to 9999, which may be retrieved by a get command
99 for editing. The default value for an unspecified c flag shall
100 be 9999.
101 ffloor
103 Specify the lowest release (that is, floor), a number greater
104 than 0 but less than 9999, which may be retrieved by a get com‐
105 mand for editing. The default value for an unspecified f flag
106 shall be 1.
107 dSID
109 Specify the default delta number (SID) to be used by a get com‐
110 mand.
111 istr
113 Treat the "No ID keywords" message issued by get or delta as a
114 fatal error. In the absence of this flag, the message is only a
115 warning. The message is issued if no SCCS identification key‐
116 words (see get ) are found in the text retrieved or stored in
117 the SCCS file. If a value is supplied, the application shall
118 ensure that the keywords exactly match the given string; how‐
119 ever, the string shall contain a keyword, and no embedded <new‐
120 line>s.
121 j
123 Allow concurrent get commands for editing on the same SID of an
124 SCCS file. This allows multiple concurrent updates to the same
125 version of the SCCS file.
126 llist
128 Specify a list of releases to which deltas can no longer be made
129 (that is, get -e against one of these locked releases fails).
130 Conforming applications shall use the following syntax to spec‐
131 ify a list. Implementations may accept additional forms as an
132 extension:
133 <list> ::= a | <range-list>
136 <range-list> ::= <range> | <range-list>, <range>
137 <range> ::= <SID>
138 The character a in the list shall be equivalent to specifying
140 all releases for the named SCCS file. The non-terminal <SID> in
141 range shall be the delta number of an existing delta associated
142 with the SCCS file.
143 n
145 Cause delta to create a null delta in each of those releases (if
146 any) being skipped when a delta is made in a new release (for
147 example, in making delta 5.1 after delta 2.7, releases 3 and 4
148 are skipped). These null deltas shall serve as anchor points so
149 that branch deltas may later be created from them. The absence
150 of this flag shall cause skipped releases to be nonexistent in
151 the SCCS file, preventing branch deltas from being created from
152 them in the future. During the initial creation of an SCCS
153 file, the n flag may be ignored; that is, if the -r option is
154 used to set the release number of the initial SID to a value
155 greater than 1, null deltas need not be created for the
156 "skipped" releases.
157 qtext
159 Substitute user-definable text for all occurrences of the %Q%
160 keyword in the SCCS file text retrieved by get.
161 mmod
163 Specify the module name of the SCCS file substituted for all
164 occurrences of the %M% keyword in the SCCS file text retrieved
165 by get. If the m flag is not specified, the value assigned shall
166 be the name of the SCCS file with the leading '.' removed.
167 ttype
169 Specify the type of module in the SCCS file substituted for all
170 occurrences of the %Y% keyword in the SCCS file text retrieved
171 by get.
172 vpgm
174 Cause delta to prompt for modification request (MR) numbers as
175 the reason for creating a delta. The optional value specifies
176 the name of an MR number validation program. (If this flag is
177 set when creating an SCCS file, the application shall ensure
178 that the m option is also used even if its value is null.)
179 -d flag
182 Remove (delete) the specified flag from an SCCS file. Several -d
183 options may be supplied on a single admin command. See the -f
184 option for allowable flag names. (The l list flag gives a list
185 of releases to be unlocked. See the -f option for further
186 description of the l flag and the syntax of a list.)
187 -a login
189 Specify a login name, or numerical group ID, to be added to the
190 list of users who may make deltas (changes) to the SCCS file. A
191 group ID shall be equivalent to specifying all login names com‐
192 mon to that group ID. Several -a options may be used on a single
193 admin command line. As many logins, or numerical group IDs, as
194 desired may be on the list simultaneously. If the list of users
195 is empty, then anyone may add deltas. If login or group ID is
196 preceded by a '!' , the users so specified shall be denied per‐
197 mission to make deltas.
198 -e login
200 Specify a login name, or numerical group ID, to be erased from
201 the list of users allowed to make deltas (changes) to the SCCS
202 file. Specifying a group ID is equivalent to specifying all
203 login names common to that group ID. Several -e options may be
204 used on a single admin command line.
205 -y[comment]
207 Insert the comment text into the SCCS file as a comment for the
208 initial delta in a manner identical to that of delta. In the
209 POSIX locale, omission of the -y option shall result in a
210 default comment line being inserted in the form:
211 "date and time created %s %s by %s", <date>, <time>, <login>
214 where <date> is expressed in the format of the date utility's %y / %m /
216 %d conversion specification, <time> in the format of the date utility's
217 %T conversion specification format, and <login> is the login name of
218 the user creating the file.
219 -m mrlist
221 Insert the list of modification request (MR) numbers into the
222 SCCS file as the reason for creating the initial delta in a man‐
223 ner identical to delta. The application shall ensure that the v
224 flag is set and the MR numbers are validated if the v flag has a
225 value (the name of an MR number validation program). A diagnos‐
226 tic message shall be written if the v flag is not set or MR val‐
227 idation fails.
228 -h Check the structure of the SCCS file and compare the newly com‐
230 puted checksum with the checksum that is stored in the SCCS
231 file. If the newly computed checksum does not match the check‐
232 sum in the SCCS file, a diagnostic message shall be written.
233 -z Recompute the SCCS file checksum and store it in the first line
235 of the SCCS file (see the -h option above). Note that use of
236 this option on a truly corrupted file may prevent future detec‐
237 tion of the corruption.
238
241 The following operands shall be supported:
242 file A pathname of an existing SCCS file or a directory. If file is a
244 directory, the admin utility shall behave as though each file in
245 the directory were specified as a named file, except that non-
246 SCCS files (last component of the pathname does not begin with
247 s.) and unreadable files shall be silently ignored.
248 newfile
250 A pathname of an SCCS file to be created.
251 If exactly one file or newfile operand appears, and it is '-' , the
254 standard input shall be read; each line of the standard input shall be
255 taken to be the name of an SCCS file to be processed. Non-SCCS files
256 and unreadable files shall be silently ignored.
257
259 The standard input shall be a text file used only if -i is specified
260 without an option-argument or if a file or newfile operand is specified
261 as '-' . If the first character of any standard input line is <SOH> in
262 the POSIX locale, the results are unspecified.
263
265 The existing SCCS files shall be text files of an unspecified format.
266 The application shall ensure that the file named by the -i option's
268 name option-argument shall be a text file; if the first character of
269 any line in this file is <SOH> in the POSIX locale, the results are
270 unspecified. If this file contains more than 99999 lines, the number of
271 lines recorded in the header for this file shall be 99999 for this
272 delta.
273
275 The following environment variables shall affect the execution of
276 admin:
277 LANG Provide a default value for the internationalization variables
279 that are unset or null. (See the Base Definitions volume of
280 IEEE Std 1003.1-2001, Section 8.2, Internationalization Vari‐
281 ables for the precedence of internationalization variables used
282 to determine the values of locale categories.)
283 LC_ALL If set to a non-empty string value, override the values of all
285 the other internationalization variables.
286 LC_CTYPE
288 Determine the locale for the interpretation of sequences of
289 bytes of text data as characters (for example, single-byte as
290 opposed to multi-byte characters in arguments and input files).
291 LC_MESSAGES
293 Determine the locale that should be used to affect the format
294 and contents of diagnostic messages written to standard error
295 and the contents of the default -y comment.
296 NLSPATH
298 Determine the location of message catalogs for the processing of
299 LC_MESSAGES .
300
303 Default.
304
306 Not used.
307
309 The standard error shall be used only for diagnostic messages.
310
312 Any SCCS files created shall be text files of an unspecified format.
313 During processing of a file, a locking z-file, as described in get ,
314 may be created and deleted.
315
317 None.
318
320 The following exit values shall be returned:
321 0 Successful completion.
323 >0 An error occurred.
325
328 Default.
329 The following sections are informative.
331
333 It is recommended that directories containing SCCS files be writable by
334 the owner only, and that SCCS files themselves be read-only. The mode
335 of the directories should allow only the owner to modify SCCS files
336 contained in the directories. The mode of the SCCS files prevents any
337 modification at all except by SCCS commands.
338
340 None.
341
343 None.
344
346 None.
347
349 delta , get , prs , what
350
352 Portions of this text are reprinted and reproduced in electronic form
353 from IEEE Std 1003.1, 2003 Edition, Standard for Information Technology
354 -- Portable Operating System Interface (POSIX), The Open Group Base
355 Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of
356 Electrical and Electronics Engineers, Inc and The Open Group. In the
357 event of any discrepancy between this version and the original IEEE and
358 The Open Group Standard, the original IEEE and The Open Group Standard
359 is the referee document. The original Standard can be obtained online
360 at http://www.opengroup.org/unix/online.html .
361IEEE/The Open Group 2003 ADMIN(P)