| 2 |
7u83 |
1 |
.\" Crown Copyright (c) 1997
|
|
|
2 |
.\"
|
|
|
3 |
.\" This TenDRA(r) Manual Page is subject to Copyright
|
|
|
4 |
.\" owned by the United Kingdom Secretary of State for Defence
|
|
|
5 |
.\" acting through the Defence Evaluation and Research Agency
|
|
|
6 |
.\" (DERA). It is made available to Recipients with a
|
|
|
7 |
.\" royalty-free licence for its use, reproduction, transfer
|
|
|
8 |
.\" to other parties and amendment for any purpose not excluding
|
|
|
9 |
.\" product development provided that any such use et cetera
|
|
|
10 |
.\" shall be deemed to be acceptance of the following conditions:-
|
|
|
11 |
.\"
|
|
|
12 |
.\" (1) Its Recipients shall ensure that this Notice is
|
|
|
13 |
.\" reproduced upon any copies or amended versions of it;
|
|
|
14 |
.\"
|
|
|
15 |
.\" (2) Any amended version of it shall be clearly marked to
|
|
|
16 |
.\" show both the nature of and the organisation responsible
|
|
|
17 |
.\" for the relevant amendment or amendments;
|
|
|
18 |
.\"
|
|
|
19 |
.\" (3) Its onward transfer from a recipient to another
|
|
|
20 |
.\" party shall be deemed to be that party's acceptance of
|
|
|
21 |
.\" these conditions;
|
|
|
22 |
.\"
|
|
|
23 |
.\" (4) DERA gives no warranty or assurance as to its
|
|
|
24 |
.\" quality or suitability for any purpose and DERA accepts
|
|
|
25 |
.\" no liability whatsoever in relation to any use to which
|
|
|
26 |
.\" it may be put.
|
|
|
27 |
.\"
|
|
|
28 |
.TH tspec 1
|
|
|
29 |
.SH NAME
|
|
|
30 |
tspec \- An API specification tool
|
|
|
31 |
.SH SYNOPSIS
|
|
|
32 |
\fBtspec\fR [ \fIoptions\fR ] \fIapi\fR
|
|
|
33 |
.PP
|
|
|
34 |
\fBtspec\fR [ \fIoptions\fR ] \fIapi\fR \fIheader\fR
|
|
|
35 |
.PP
|
|
|
36 |
\fBtspec\fR [ \fIoptions\fR ] \fIapi\fR \fIheader\fR \fIsubset\fR
|
|
|
37 |
.PP
|
|
|
38 |
\fBtspec\fR [ \fIoptions\fR ] \fB-l\fR \fIfile\fR
|
|
|
39 |
.\" ----------------------------------------------------------------------
|
|
|
40 |
.SH DESCRIPTION
|
|
|
41 |
\fBtspec\fR is a tool for translating a form of API (Application
|
|
|
42 |
Programming Interface) description into the \fI#pragma\fR headers used
|
|
|
43 |
by \fItcc\fR(1) to represent such APIs. It is more fully documented
|
|
|
44 |
in \fItspec - An API Specification Tool\fR.
|
|
|
45 |
.PP
|
|
|
46 |
There are two basic forms of command-line. The first specifies that
|
|
|
47 |
\fBtspec\fR should process the whole of the API description \fIapi\fR, or
|
|
|
48 |
just one header from it, \fIheader\fR, or just a subset of that header,
|
|
|
49 |
\fIsubset\fR, writing its output to the standard output directory. The
|
|
|
50 |
second (using the \fB-l\fR option) specifies that it should process a
|
|
|
51 |
single file, writing the output to the standard output.
|
|
|
52 |
.\" ----------------------------------------------------------------------
|
|
|
53 |
.SH OPTIONS
|
|
|
54 |
.\" ----------------------------------------------------------------------
|
|
|
55 |
.IP \fB-C\fIfile\fR
|
|
|
56 |
Causes \fBtspec\fR to insert the contents of \fIfile\fR as a copyright
|
|
|
57 |
message at the start of each output file. This can also be specified
|
|
|
58 |
using the \fBTSPEC_COPYRIGHT\fR environmental variable. The order of
|
|
|
59 |
precedence for this and other similar options is, built-in values
|
|
|
60 |
lowest, environmental variables next, and command-line options highest.
|
|
|
61 |
.\" ----------------------------------------------------------------------
|
|
|
62 |
.IP \fB-I\fIdir\fR
|
|
|
63 |
Add the colon-separated list of directories \fIdir\fR to the list of
|
|
|
64 |
directories searched for input files. Input directories can also be
|
|
|
65 |
specified using the \fBTSPEC_INPUT\fR environmental variable.
|
|
|
66 |
.\" ----------------------------------------------------------------------
|
|
|
67 |
.IP \fB-O\fIdir\fR
|
|
|
68 |
Specifies that the directory \fIdir\fR should be used as a base for the
|
|
|
69 |
include output files. This can also be specified using the
|
|
|
70 |
\fBTSPEC_INCL_OUTPUT\fR or the \fBTSPEC_OUTPUT\fR environmental variable.
|
|
|
71 |
In the latter case it is given by \fB${TSPEC_OUTPUT}/include\fR.
|
|
|
72 |
.\" ----------------------------------------------------------------------
|
|
|
73 |
.IP \fB-S\fIdir\fR
|
|
|
74 |
Specifies that the directory \fIdir\fR should be used as a base for the
|
|
|
75 |
source output files. This can also be specified using the
|
|
|
76 |
\fBTSPEC_SRC_OUTPUT\fR or the \fBTSPEC_OUTPUT\fR environmental variable.
|
|
|
77 |
In the latter case it is given by \fB${TSPEC_OUTPUT}/src\fR.
|
|
|
78 |
.\" ----------------------------------------------------------------------
|
|
|
79 |
.IP \fB-c\fR
|
|
|
80 |
Causes \fBtspec\fR to only check the input files, not to generate any
|
|
|
81 |
output files.
|
|
|
82 |
.\" ----------------------------------------------------------------------
|
|
|
83 |
.IP \fB-e\fR
|
|
|
84 |
Causes \fBtspec\fR to only run its preprocessor phase, writing the output
|
|
|
85 |
to the standard output.
|
|
|
86 |
.\" ----------------------------------------------------------------------
|
|
|
87 |
.IP \fB-f\fR
|
|
|
88 |
Causes \fBtspec\fR to ignore date stamps when deciding whether it is
|
|
|
89 |
necessary to update an output file, and to force it to be updated.
|
|
|
90 |
.\" ----------------------------------------------------------------------
|
|
|
91 |
.IP \fB-i\fR
|
|
|
92 |
Causes \fBtspec\fR to print an index of all the objects specified in
|
|
|
93 |
the input files to the standard output. This index is designed to be
|
|
|
94 |
used as a quick guide to the contents of an API.
|
|
|
95 |
.\" ----------------------------------------------------------------------
|
|
|
96 |
.IP \fB-l\fR
|
|
|
97 |
Specifies local input mode (see above).
|
|
|
98 |
.\" ----------------------------------------------------------------------
|
|
|
99 |
.IP \fB-m\fR
|
|
|
100 |
Causes \fBtspec\fR to print an index intended for machine processing of
|
|
|
101 |
all the objects specified in the input files to the standard output.
|
|
|
102 |
This index is suitable for processing with text processing tools such
|
|
|
103 |
as \fIawk\fR(1).
|
|
|
104 |
.\" ----------------------------------------------------------------------
|
|
|
105 |
.IP \fB-n\fR
|
|
|
106 |
Causes \fBtspec\fR to update any output files which are younger than
|
|
|
107 |
the \fBtspec\fR executable. This is useful primarily in development
|
|
|
108 |
work on \fBtspec\fR.
|
|
|
109 |
.\" ----------------------------------------------------------------------
|
|
|
110 |
.IP \fB-p\fR
|
|
|
111 |
Indicates to \fBtspec\fR that its input has already been preprocessed
|
|
|
112 |
(i.e. that it is the output of a previous \fB-e\fR option).
|
|
|
113 |
.\" ----------------------------------------------------------------------
|
|
|
114 |
.IP \fB-r\fR
|
|
|
115 |
Causes \fBtspec\fR to only produce output for implemented, as opposed to
|
|
|
116 |
used, objects.
|
|
|
117 |
.\" ----------------------------------------------------------------------
|
|
|
118 |
.IP \fB-s\fR
|
|
|
119 |
Causes \fBtspec\fR to check each header in an API separately, as opposed
|
|
|
120 |
to all at once (as with the \fB-c\fR option).
|
|
|
121 |
.\" ----------------------------------------------------------------------
|
|
|
122 |
.IP \fB-u\fR
|
|
|
123 |
Causes \fBtspec\fR to generate unique token names for the objects in
|
|
|
124 |
its input files.
|
|
|
125 |
.\" ----------------------------------------------------------------------
|
|
|
126 |
.IP \fB-v\fR
|
|
|
127 |
Causes \fBtspec\fR to enter verbose mode, in which it reports on the
|
|
|
128 |
output files it creates. If two \fB-v\fR options are given then
|
|
|
129 |
\fBtspec\fR enters very verbose mode, in which it gives more information
|
|
|
130 |
on its activities.
|
|
|
131 |
.\" ----------------------------------------------------------------------
|
|
|
132 |
.SH SEE ALSO
|
|
|
133 |
\fItcc\fR(1), \fItdfc\fR(1).
|
|
|
134 |
.\" ----------------------------------------------------------------------
|