← Back to branch summary

~ubuntu-branches/ubuntu/vivid/cproto/vivid-proposed

« back to all changes in this revision

Viewing changes to cproto.1

  • Committer: Bazaar Package Importer
  • Author(s): Kenneth J. Pronovici
  • Date: 2010-07-10 19:23:35 UTC
  • Revision ID: james.westby@ubuntu.com-20100710192335-zechijrook4av4a3
Tags: 4.7h-5
* Fix warnings from the Full Lintian Report in the PTS.
  - Properly escape "-" in cproto.1 (in manpages.patch)

Show diffs side-by-side

added added

removed removed

Lines of Context:
cproto.1
90
90
The program does not change anything within function bodies.
91
91
.LP
92
92
.B Cproto
93
 
can optionally generate source in lint-library format.
 
93
can optionally generate source in lint\-library format.
94
94
This is useful in environments where the \fBlint\fR utility is
95
95
used to supplement prototype checking of your program.
96
96
.
129
129
.EE
130
130
.TP
131
131
.B \-l
132
 
Generate text for a lint-library (overrides the "\fB\-f\fR" option).
 
132
Generate text for a lint\-library (overrides the "\fB\-f\fR" option).
133
133
The output includes the comment
134
134
.EX
135
135
/* LINTLIBRARY */
136
136
.EE
137
137
Special comments LINT_EXTERN and LINT_PREPRO (a la "VARARGS")
138
 
respectively turn on the "-x"
139
 
option and copy comment-text to the output (for preprocessing in \fBlint\fR).
 
138
respectively turn on the "\-x"
 
139
option and copy comment\-text to the output (for preprocessing in \fBlint\fR).
140
140
Use the comment
141
141
.EX
142
142
/* LINT_EXTERN2 */
143
143
.EE
144
 
to include externs defined in the first level of include-files.
 
144
to include externs defined in the first level of include\-files.
145
145
Use the comment
146
146
.EX
147
147
/* LINT_SHADOWED */
154
154
.P
155
155
Note that these special comments
156
156
are not supported under VAX/VMS, since there is no
157
 
equivalent for the "-C" option of cpp with VAX-C.
 
157
equivalent for the "\-C" option of cpp with VAX\-C.
158
158
.TP
159
159
.B \-c
160
160
The parameter comments in the prototypes generated by
224
224
.TP
225
225
.B \-T
226
226
Copy type definitions from each file.
227
 
(Definitions in included-files are copied, unlike the "-l" option).
 
227
(Definitions in included\-files are copied, unlike the "\-l" option).
228
228
.TP
229
229
.B \-v
230
230
Also output declarations for variables defined in the source.
234
234
to be included in the output.
235
235
.TP
236
236
.BI \-X " level"
237
 
This option limits the include-file level from which declarations are extracted
 
237
This option limits the include\-file level from which declarations are extracted
238
238
by examining the preprocessor output.
239
239
.TP
240
240
.B \-a
287
287
whitespace characters.
288
288
For example, the option
289
289
.EX
290
 
-F"int f(\\n\\ta,\\n\\tb\\n\\t)"
 
290
\-F"int f(\\n\\ta,\\n\\tb\\n\\t)"
291
291
.EE
292
292
will produce
293
293
.EX
329
329
environment option.
330
330
.
331
331
.SH BUGS
332
 
If an un-tagged struct, union or enum declaration appears in
 
332
If an un\-tagged struct, union or enum declaration appears in
333
333
a generated function prototype or converted function definition,
334
334
the content of the declaration between the braces is empty.
335
335
.LP
359
359
.EE
360
360
.LP
361
361
VARARGS comments don't get passed through on systems whose C preprocessors
362
 
don't support this (e.g., VAX/VMS, MS-DOS).
 
362
don't support this (e.g., VAX/VMS, MS\-DOS).
363
363
.
364
364
.SH AUTHOR
365
365
.nf
368
368
cthuang@interlog.com
369
369
.sp
370
370
Thomas Dickey
371
 
dickey@invisible-island.net
372
 
modifications to support lint library, type-copying, and port to VAX/VMS.
 
371
dickey@invisible\-island.net
 
372
modifications to support lint library, type\-copying, and port to VAX/VMS.
373
373
.fi
374
374
.
375
375
.SH "SEE ALSO"