NAME
prs — print an
SCCS file (DEVELOPMENT)
SYNOPSIS
prs |
[-a][-d
dataspec][-r[SID]file
...] file... [XSI] |
prs |
[-e | -l]
-c cutoff
[-d dataspec] file...
[XSI] |
prs |
[-e | -l]
-r[SID][-d
dataspec]file... |
DESCRIPTION
The prs utility shall write to standard
output parts or all of an SCCS file in a user-supplied format.
OPTIONS
The prs utility shall conform to the Base
Definitions volume of IEEE Std 1003.1-2001
(“POSIX.1”), xbd_chap12(7), except
that the -r option has an optional option-argument.
This optional option-argument cannot be presented as a separate argument.
The following options shall be supported:
- -d dataspec
- Specify the output data specification. The dataspec shall be a string consisting of SCCS file data keywords (see Data Keywords ) interspersed with optional user-supplied text.
- -r[SID]
- Specify the SCCS identification string (SID) of a delta for which information is desired. If no SID option-argument is specified, the SID of the most recently created delta shall be assumed.
-e- Request information for all deltas created earlier than and including the
delta designated via the
-roption or the date-time given by the-coption. -l- Request information for all deltas created later than and including the
delta designated via the
-roption or the date-time given by the-coption. - -c cutoff
- Indicate the cutoff date-time, in the form:
YY[MM[DD[HH[MM[SS]]]]]
For the YY component, values in the range [69,99] shall refer to years 1969 to 1999 inclusive, and values in the range [00,68] shall refer to years 2000 to 2068 inclusive.
- Note:
- It is expected that in a future version of IEEE Std 1003.1-2001 (“POSIX.1”) the default century inferred from a 2-digit year will change. (This would apply to all commands accepting a 2-digit year as input.)
No changes (deltas) to the SCCS file that were created after the specified cutoff date-time shall be included in the output. Units omitted from the date-time default to their maximum possible values; for example, -c 7502 is equivalent to -c 750228235959.
-a- Request writing of information for both removed-that is,
delta type = R (see
rmdel
)- and existing-that is, delta type = D ,- deltas. If
the
-aoption is not specified, information for existing deltas only shall be provided.
OPERANDS
The following operand shall be supported:
- file
- A pathname of an existing SCCS file or a directory. If file is a
directory, the
prsutility shall behave 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 shall be silently ignored.If exactly one file operand appears, and it is ‘
-’, the standard input shall be read; each line of the standard input shall be taken to be the name of an SCCS file to be processed. Non-SCCS files and unreadable files shall be silently ignored.
STDIN
The standard input shall be a text file used only when the
file
operand is specified as ‘-’. Each line
of the text file shall be interpreted as an SCCS pathname.
INPUT FILES
Any SCCS files displayed are files of an unspecified format.
ENVIRONMENT VARIABLES
The following environment variables shall affect the execution of
prs:
LANG- Provide a default value for the internationalization variables that are unset or null. (See the Base Definitions volume of IEEE Std 1003.1-2001 (“POSIX.1”), Section 8.2, Internationalization Variables for the precedence of internationalization variables used to determine the values of locale categories.)
LC_ALL- If set to a non-empty string value, override the values of all the other internationalization variables.
LC_CTYPE- Determine the locale for the interpretation of sequences of bytes of text data as characters (for example, single-byte as opposed to multi-byte characters in arguments and input files).
LC_MESSAGES- Determine the locale that should be used to affect the format and contents of diagnostic messages written to standard error.
NLSPATH- Determine the location of message catalogs for the processing of LC_MESSAGES .
ASYNCHRONOUS EVENTS
Default.
STDOUT
The standard output shall be a text file whose format is dependent
on the data keywords specified with the -d
option.
Data Keywords
Data keywords specify which parts of an SCCS file shall be retrieved and output. All parts of an SCCS file have an associated data keyword. A data keyword may appear in a dataspec multiple times.
The information written by prs shall
consist of:
- The user-supplied text
- Appropriate values (extracted from the SCCS file) substituted for the recognized data keywords in the order of appearance in the dataspec
The format of a data keyword value shall either be simple (
‘S’ ), in which keyword substitution
is direct, or multi-line ( ‘M’ ).
User-supplied text shall be any text other than recognized data
keywords. A <tab> shall be specified by
‘\t’ and <newline> by
‘\n’. When the
-r option is not specified, the default
dataspec shall be:
:PN::\n\n
and the following dataspec shall be used for each selected delta:
:Dt:\t:DL:\nMRs:\n:MR:COMMENTS:\n:C:
| SCCS File Data Keywords | ||||
| Keyword | Data Item | File Section | Value | Format |
| :Dt: | Delta information | Delta Table | See below* | S |
| :DL: | Delta line statistics | Ta :Li:/:Ld:/:Lu: Ta S | ||
| :Li: | Lines inserted by Delta | Ta nnnnn*** Ta S | ||
| :Ld: | Lines deleted by Delta | Ta nnnnn*** Ta S | ||
| :Lu: | Lines unchanged by Delta | Ta nnnnn*** Ta S | ||
| :DT: | Delta type | Ta D or R Ta S | ||
| :I: | SCCS ID string (SID) | Ta See below** Ta S | ||
| :R: | Release number | Ta nnnn Ta S | ||
| :L: | Level number | Ta nnnn Ta S | ||
| :B: | Branch number | Ta nnnn Ta S | ||
| :S: | Sequence number | Ta nnnn Ta S | ||
| :D: | Date delta created | Ta :Dy:/:Dm:/:Dd: Ta S | ||
| :Dy: | Year delta created | Ta nn Ta S | ||
| :Dm: | Month delta created | Ta nn Ta S | ||
| :Dd: | Day delta created | Ta nn Ta S | ||
| :T: | Time delta created | Ta :Th:::Tm:::Ts: Ta S | ||
| :Th: | Hour delta created | Ta nn Ta S | ||
| :Tm: | Minutes delta created | Ta nn Ta S | ||
| :Ts: | Seconds delta created | Ta nn Ta S | ||
| :P: | Programmer who created Delta | Ta logname Ta S | ||
| :DS: | Delta sequence number | Ta nnnn Ta S | ||
| :DP: | Predecessor Delta sequence | Ta nnnn Ta S | ||
| number | ||||
| :DI: | Sequence number of deltas | Ta :Dn:/:Dx:/:Dg: Ta S | ||
| included, excluded, or ignored | ||||
| :Dn: | Deltas included (sequence #) | Ta :DS: :DS: ... Ta S | ||
| :Dx: | Deltas excluded (sequence #) | Ta :DS: :DS: ... Ta S | ||
| :Dg: | Deltas ignored (sequence #) | Ta :DS: :DS: ... Ta S | ||
| :MR: | MR numbers for delta | Ta text Ta M | ||
| :C: | Comments for delta | Ta text Ta M | ||
| :UN: | User names | User Names | text | M |
| :FL: | Flag list | Flags | text | M |
| :Y: | Module type flag | Ta text Ta S | ||
| :MF: | MR validation flag | Ta yes or no Ta S | ||
| :MP: | MR validation program name | Ta text Ta S | ||
| :KF: | Keyword error, warning flag | Ta yes or no Ta S | ||
| :KV: | Keyword validation string | Ta text Ta S | ||
| :BF: | Branch flag | Ta yes or no Ta S | ||
| :J: | Joint edit flag | Ta yes or no Ta S | ||
| :LK: | Locked releases | Ta :R: ... Ta S | ||
| :Q: | User-defined keyword | Ta text Ta S | ||
| :M: | Module name | Ta text Ta S | ||
| :FB: | Floor boundary | Ta :R: Ta S | ||
| :CB: | Ceiling boundary | Ta :R: Ta S | ||
| :Ds: | Default SID | Ta :I: Ta S | ||
| :ND: | Null delta flag | Ta yes or no Ta S | ||
| :FD: | File descriptive text | Comments | text | M |
| :BD: | Body | Body | text | M |
| :GB: | Gotten body | Ta text Ta M | ||
| :W: | A form of what string | N/A | :Z::M:\t:I: | S |
| :A: | A form of what string | N/A | :Z::Y: :M: :I::Z: | S |
| :Z: | what string delimiter | N/A | @(#) | S |
| :F: | SCCS filename | N/A | text | S |
| :PN: | SCCS file pathname | N/A | text | S |
- *
- :Dt: = :DT: :I: :D: :T: :P: :DS: :DP:
- **
- :R:.:L:.:B:.:S: if the delta is a branch delta ( :BF: == yes )
:R:.:L: if the delta is not a branch delta ( :BF: == no ) - ***
- The line statistics are capped at 99999. For example, if 100000 lines were unchanged in a certain revision, :Lu: shall produce the value 99999.
STDERR
The standard error shall be used only for diagnostic messages.
OUTPUT FILES
None.
EXTENDED DESCRIPTION
None.
EXIT STATUS
The following exit values shall be returned:
CONSEQUENCES OF ERRORS
Default.
APPLICATION USAGE
None.
EXAMPLES
- The following example:
prs -d "User Names for :F: are:\n:UN:" s.file
might write to standard output:
User Names for s.file are: xyz 131 abc
- The following example:
prs -d "Delta for pgm :M:: :I: - :D: By :P:" -r s.file
might write to standard output:
Delta for pgm main.c: 3.7 - 77/12/01 By cas
- As a special case:
prs s.file
might write to standard output:
s.file: <blank line> D 1.1 77/12/01 00:00:00 cas 1 000000/00000/00000 MRs: bl78-12345 bl79-54321 COMMENTS: this is the comment line for s.file initial delta <blank line>
for each delta table entry of the D type. The only option allowed to be used with this special case is the
-aoption.
RATIONALE
None.
FUTURE DIRECTIONS
None.
SEE ALSO
CHANGE HISTORY
First released in Issue 2.
Issue 5
The phrase "in which keyword substitution is followed by a <newline>" is deleted from the end of the second paragraph of Data Keywords.
The interpretation of the YY component of the
-c cutoff argument is noted.
Issue 6
The normative text is reworded to emphasize the term "shall" for implementation requirements.
The Open Group Base Resolution bwg2001-007 is applied, updating the table in STDOUT with a note that line statistics are capped at 99999 for the :Li:, :Ld:, :Lu:, and :DL: keywords.
The Open Group Interpretation PIN4C.00009 is applied.
End of informative text. footer end