| Line 22... |
Line 22... |
| 22 |
.\"
|
22 |
.\"
|
| 23 |
.\" (4) DERA gives no warranty or assurance as to its
|
23 |
.\" (4) DERA gives no warranty or assurance as to its
|
| 24 |
.\" quality or suitability for any purpose and DERA accepts
|
24 |
.\" quality or suitability for any purpose and DERA accepts
|
| 25 |
.\" no liability whatsoever in relation to any use to which
|
25 |
.\" no liability whatsoever in relation to any use to which
|
| 26 |
.\" it may be put.
|
26 |
.\" it may be put.
|
| - |
|
27 |
.\"
|
| - |
|
28 |
.\" $Id$
|
| 27 |
.\"
|
29 |
.\"
|
| 28 |
.TH tspec 1
|
30 |
.TH tspec 1
|
| 29 |
.SH NAME
|
31 |
.SH NAME
|
| 30 |
tspec \- An API specification tool
|
32 |
tspec \- An API specification tool
|
| 31 |
.SH SYNOPSIS
|
33 |
.SH SYNOPSIS
|
| Line 73... |
Line 75... |
| 73 |
.IP \fB-S\fIdir\fR
|
75 |
.IP \fB-S\fIdir\fR
|
| 74 |
Specifies that the directory \fIdir\fR should be used as a base for the
|
76 |
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
|
77 |
source output files. This can also be specified using the
|
| 76 |
\fBTSPEC_SRC_OUTPUT\fR or the \fBTSPEC_OUTPUT\fR environmental variable.
|
78 |
\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.
|
79 |
In the latter case it is given by \fB${TSPEC_OUTPUT}/src\fR.
|
| - |
|
80 |
.\" ----------------------------------------------------------------------
|
| - |
|
81 |
.IP \fB-V\fR
|
| - |
|
82 |
Causes \fBtspec\fR to print the program's version, as well as the TenDRA
|
| - |
|
83 |
release.
|
| - |
|
84 |
.\" ----------------------------------------------------------------------
|
| - |
|
85 |
.IP \fB-a\fR
|
| - |
|
86 |
Causes \fBtspec\fR to check all headers in an API at once, as opposed to
|
| - |
|
87 |
separately (as with the \fB-s\fR option).
|
| 78 |
.\" ----------------------------------------------------------------------
|
88 |
.\" ----------------------------------------------------------------------
|
| 79 |
.IP \fB-c\fR
|
89 |
.IP \fB-c\fR
|
| 80 |
Causes \fBtspec\fR to only check the input files, not to generate any
|
90 |
Causes \fBtspec\fR to only check the input files, not to generate any
|
| 81 |
output files.
|
91 |
output files.
|
| 82 |
.\" ----------------------------------------------------------------------
|
92 |
.\" ----------------------------------------------------------------------
|
| Line 99... |
Line 109... |
| 99 |
.IP \fB-m\fR
|
109 |
.IP \fB-m\fR
|
| 100 |
Causes \fBtspec\fR to print an index intended for machine processing of
|
110 |
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.
|
111 |
all the objects specified in the input files to the standard output.
|
| 102 |
This index is suitable for processing with text processing tools such
|
112 |
This index is suitable for processing with text processing tools such
|
| 103 |
as \fIawk\fR(1).
|
113 |
as \fIawk\fR(1).
|
| 104 |
.\" ----------------------------------------------------------------------
|
114 |
.\" ----------------------------------------------------------------------
|
| 105 |
.IP \fB-n\fR
|
115 |
.IP \fB-n\fR
|
| 106 |
Causes \fBtspec\fR to update any output files which are younger than
|
116 |
Causes \fBtspec\fR to update any output files which are younger than
|
| 107 |
the \fBtspec\fR executable. This is useful primarily in development
|
117 |
the \fBtspec\fR executable. This is useful primarily in development
|
| 108 |
work on \fBtspec\fR.
|
118 |
work on \fBtspec\fR.
|
| 109 |
.\" ----------------------------------------------------------------------
|
119 |
.\" ----------------------------------------------------------------------
|
| 110 |
.IP \fB-p\fR
|
120 |
.IP \fB-p\fR
|
| 111 |
Indicates to \fBtspec\fR that its input has already been preprocessed
|
121 |
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).
|
122 |
(i.e. that it is the output of a previous \fB-e\fR option).
|
| 113 |
.\" ----------------------------------------------------------------------
|
123 |
.\" ----------------------------------------------------------------------
|
| 114 |
.IP \fB-r\fR
|
124 |
.IP \fB-r\fR
|
| 115 |
Causes \fBtspec\fR to only produce output for implemented, as opposed to
|
125 |
Causes \fBtspec\fR to only produce output for implemented, as opposed to
|
| 116 |
used, objects.
|
126 |
used, objects.
|
| 117 |
.\" ----------------------------------------------------------------------
|
127 |
.\" ----------------------------------------------------------------------
|
| 118 |
.IP \fB-s\fR
|
128 |
.IP \fB-s\fR
|
| 119 |
Causes \fBtspec\fR to check each header in an API separately, as opposed
|
129 |
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).
|
130 |
to all at once (as with the \fB-a\fR option).
|
| - |
|
131 |
.\" ----------------------------------------------------------------------
|
| - |
|
132 |
.IP \fB-t\fR
|
| - |
|
133 |
Causes \fBtspec\fR to allow long long type specifiers.
|
| 121 |
.\" ----------------------------------------------------------------------
|
134 |
.\" ----------------------------------------------------------------------
|
| 122 |
.IP \fB-u\fR
|
135 |
.IP \fB-u\fR
|
| 123 |
Causes \fBtspec\fR to generate unique token names for the objects in
|
136 |
Causes \fBtspec\fR to generate unique token names for the objects in
|
| 124 |
its input files.
|
137 |
its input files.
|
| 125 |
.\" ----------------------------------------------------------------------
|
138 |
.\" ----------------------------------------------------------------------
|