| 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 disp 1
|
|
|
29 |
.SH NAME
|
|
|
30 |
disp \- TDF pretty printer
|
|
|
31 |
.SH SYNOPSIS
|
|
|
32 |
\fBdisp\fR [ \fIoptions\fR ] \fIinput-file\fR [ \fIoutput-file\fR ]
|
|
|
33 |
.\" ----------------------------------------------------------------------
|
|
|
34 |
.SH DESCRIPTION
|
|
|
35 |
\fBdisp\fR translates the input TDF capsule, \fIinput-file\fR into a
|
|
|
36 |
human-readable form, the layout of which reflects the structure of the
|
|
|
37 |
underlying TDF tree. If the \fIoutput-file\fR argument is present, this
|
|
|
38 |
is used for output; otherwise the standard output is used.
|
|
|
39 |
.PP
|
|
|
40 |
Whenever possible the output of \fBdisp\fR matches the TDF specification.
|
|
|
41 |
The most important exception is the use of asterisks after a token
|
|
|
42 |
name to indicate an application of that token. Also a dash is used to
|
|
|
43 |
indicate the absense of an optional argument and an ellipsis (...) is used
|
|
|
44 |
to indicate that a token's arguments have been skipped rather than decoded
|
|
|
45 |
(since the token was undeclared).
|
|
|
46 |
.PP
|
|
|
47 |
It is recommended that \fBdisp\fR is invoked via \fItcc\fR(1) using
|
|
|
48 |
the \fB-disp\fR or the \fB-disp_t\fR option. The \fB-\fIopt\fR flag can
|
|
|
49 |
be passed to \fBdisp\fR by passing the flag \fB-Wd,-\fIopt\fR to \fItcc\fR.
|
|
|
50 |
.\" ----------------------------------------------------------------------
|
|
|
51 |
.SH OPTIONS
|
|
|
52 |
.\" ----------------------------------------------------------------------
|
|
|
53 |
.IP \fB-g\fR
|
|
|
54 |
Makes \fBdisp\fR print any diagnostic information units within the
|
|
|
55 |
TDF capsule.
|
|
|
56 |
.\" ----------------------------------------------------------------------
|
|
|
57 |
.IP \fB-n\fIcolumns\fR
|
|
|
58 |
Makes \fBdisp\fR try to format its output to fit into a page width
|
|
|
59 |
of \fIcolumns\fR. The default page width is 80.
|
|
|
60 |
.\" ----------------------------------------------------------------------
|
|
|
61 |
.IP \fB-q\fR
|
|
|
62 |
Makes \fBdisp\fR ignore the specified page width and print its output
|
|
|
63 |
with the minimum possible indentation. This makes it run faster, but
|
|
|
64 |
does not make the best use of the available page width.
|
|
|
65 |
.\" ----------------------------------------------------------------------
|
|
|
66 |
.IP \fB-r\fR
|
|
|
67 |
Makes \fBdisp\fR continue after any errors. The use of this flag is
|
|
|
68 |
not recommended since anything read after an error is likely to be of
|
|
|
69 |
very little value.
|
|
|
70 |
.\" ----------------------------------------------------------------------
|
|
|
71 |
.IP \fB-v\fR
|
|
|
72 |
Makes \fBdisp\fR print its version number and the version of the TDF
|
|
|
73 |
specification it supports.
|
|
|
74 |
.\" ----------------------------------------------------------------------
|
|
|
75 |
.IP \fB-A\fR
|
|
|
76 |
Makes \fBdisp\fR decode all the units it recognises (including diagnostic
|
|
|
77 |
and linking units) within the TDF capsule.
|
|
|
78 |
.\" ----------------------------------------------------------------------
|
|
|
79 |
.IP \fB-D\fR
|
|
|
80 |
Makes \fBdisp\fR print a simple binary dump of the input file. This
|
|
|
81 |
is intended for debugging purposes.
|
|
|
82 |
.\" ----------------------------------------------------------------------
|
|
|
83 |
.IP \fB-E\fR
|
|
|
84 |
Makes \fBdisp\fR report such information as the number of external tags
|
|
|
85 |
and tokens which it usually omits.
|
|
|
86 |
.\" ----------------------------------------------------------------------
|
|
|
87 |
.IP \fB-S\fR
|
|
|
88 |
Because tokens may be defined in terms of other tokens and do not need
|
|
|
89 |
to be declared before they are defined, \fBdisp\fR makes two passes of
|
|
|
90 |
all the token definition units. In the first pass it extracts only
|
|
|
91 |
the declaration information, stepping over the main body of the
|
|
|
92 |
definition. On the second pass all the information is read.
|
|
|
93 |
The \fB-S\fR option makes \fBdisp\fR skip the first pass.
|
|
|
94 |
.\" ----------------------------------------------------------------------
|
|
|
95 |
.IP \fB-T\fR
|
|
|
96 |
The skip pass described under the \fB-S\fR option is usual done silently,
|
|
|
97 |
without printing any information. This is changed by the \fB-T\fR option.
|
|
|
98 |
.\" ----------------------------------------------------------------------
|
|
|
99 |
.IP \fB-U\fR
|
|
|
100 |
Makes \fBdisp\fR print the usage information associated with the
|
|
|
101 |
external tokens and tags and also any linkage information units within
|
|
|
102 |
the capsule.
|
|
|
103 |
.\" ----------------------------------------------------------------------
|
|
|
104 |
.IP \fB-V\fR
|
|
|
105 |
By default \fBdisp\fR attempts to rationalise the TDF it reads. In
|
|
|
106 |
particular it uses the external token and tag names whenever possible,
|
|
|
107 |
following the token and tag bindings to find these, and makes up names
|
|
|
108 |
for those tokens and tags which do not have external names. The \fB-V\fR
|
|
|
109 |
option makes it not attempt any such rationalisation, but instead to
|
|
|
110 |
output exactly what it reads.
|
|
|
111 |
.\" ----------------------------------------------------------------------
|
|
|
112 |
.IP \fB-W\fR
|
|
|
113 |
Makes \fBdisp\fR issue a warning about every token which is used before
|
|
|
114 |
it is declared.
|
|
|
115 |
.\" ----------------------------------------------------------------------
|
|
|
116 |
.SH DIAGNOSTICS
|
|
|
117 |
The error reports if the input file is not a legal TDF capsule are
|
|
|
118 |
intended to aid developers writing programs which produce TDF. Thus
|
|
|
119 |
they try to give all the information that may be required, including
|
|
|
120 |
the position within the input file that the error occurred.
|
|
|
121 |
.\" ----------------------------------------------------------------------
|
|
|
122 |
.SH SEE ALSO
|
|
|
123 |
\fItcc\fR(1).
|
|
|
124 |
.\" ----------------------------------------------------------------------
|