TIVI-153: Add as dependency for iputils
[profile/ivi/opensp.git] / doc / sgmlnorm.htm
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML Strict//EN">
2 <HTML>
3 <HEAD>
4 <TITLE>OSGMLNORM</TITLE>
5 </HEAD>
6 <BODY>
7 <H1>OSGMLNORM</H1>
8 <H4>
9 An SGML System Conforming to International Standard ISO 8879 --
10 Standard Generalized Markup Language
11 </H4>
12 <H4>
13 An SGML Extended Facilities system conforming to
14 Annex A of International Standard ISO/IEC 10744 --
15 Hypermedia/Time-based Structuring Language
16 </H4>
17 <H2>SYNOPSIS</H2>
18 <P>
19 <CODE>osgmlnorm</CODE> [ <CODE>option...</CODE> ] <CODE><VAR>sysid...</VAR></CODE>
20  
21 <H2>DESCRIPTION</H2>
22 <P>
23 Osgmlnorm prints on the standard output a <I>normalized</I> document instance
24 for the SGML document contained in the concatenation of the entities
25 with <A HREF="sysid.htm">system identifiers</A>
26 <CODE><VAR>sysid...</VAR></CODE>.
27 <P>
28 When the normalized instance is prefixed with the original SGML declaration
29 and prolog, it will have the same ESIS as the original SGML document,
30 with the following exceptions:
31 <UL>
32 <LI>
33 The output of osgmlnorm does not protect against the recognition of
34 short reference delimiters, so any <SAMP>USEMAP</SAMP> declarations
35 must be removed from the DTD.
36 <LI>
37 The normalized instance will use the reference delimiters, even if the
38 original instance did not.
39 <LI>
40 If marked sections are included in the output using the
41 <CODE>-m</CODE> option, the reference reserved names will be used for
42 the status keywords even if the original instance did not.
43 <LI>
44 Any ESIS information relating to the SGML LINK feature will be lost.
45 </UL>
46 <P>
47 The normalized instance will not use any markup minimization features
48 except that:
49 <UL>
50 <LI>
51 Any attributes that were not specified in the original instance
52 will not be included in the normalized instance.
53 (Current attributes will be included.)
54 <LI>
55 If the declared value of an attribute was a name token group,
56 and a value was specified that was the same as the name of
57 the attribute, then the attribute name and value indicator will be
58 omitted.
59 For example, with HTML osgmlnorm would output <CODE>&lt;DL COMPACT&gt;</CODE>
60 rather than <CODE>&lt;DL COMPACT="COMPACT"&gt;</CODE>
61 </UL>
62 <H2>OPTIONS</H2>
63 <P>
64 The following options are available:
65 <DL>
66 <DT>
67 <CODE>-b<VAR>name</VAR></CODE>,
68 <CODE>--bctf=<VAR>name</VAR></CODE>
69 <DD>
70 Use the <A HREF="sysid.htm#bctf">BCTF</A> <VAR>name</VAR> for output.
71 <DT>
72 <CODE>-c<VAR>sysid</VAR></CODE>,
73 <CODE>--catalog=<VAR>sysid</VAR></CODE>
74 <DD>
75 Map public identifiers and entity names to system identifiers
76 using the catalog entry file whose system identifier is <VAR>sysid</VAR>.
77 This has the same effect as in <A HREF="nsgmls.htm#optc">onsgmls</A>.
78 <DT>
79 <CODE>-C</CODE>,
80 <CODE>--catalogs</CODE>
81 <DD>
82 This has the same effect as in <A HREF="nsgmls.htm#optC">onsgmls</A>.
83 <DT>
84 <CODE>-d</CODE>,
85 <CODE>--dtd</CODE>
86 <DD>
87 Output a document type declaration with the same external
88 identifier as the input document, and with no
89 internal declaration subset.
90 No check is performed that the document instance is valid
91 with respect to this DTD.
92 <DT>
93 <CODE>-D<VAR>directory</VAR></CODE>,
94 <CODE>--directory=<VAR>directory</VAR></CODE>
95 <DD>
96 Search
97 <CODE><VAR>directory</VAR></CODE>
98 for files specified in system identifiers.
99 This has the same effect as in <A HREF="nsgmls.htm#optD">onsgmls</A>.
100 <DT>
101 <CODE>-e</CODE>,
102 <CODE>--open-entities</CODE>
103 <DD>
104 Describe open entities in error messages.
105 <DT>
106 <CODE>-i<VAR>name</VAR></CODE>,
107 <CODE>--include=<VAR>name</VAR></CODE>
108 <DD>
109 This has the same effect as in <A HREF="nsgmls.htm#opti">onsgmls</A>.
110 <DT>
111 <CODE>-m</CODE>,
112 <CODE>--marked-sections</CODE>
113 <DD>
114 Output any marked sections that were in the input document instance.
115 <DT>
116 <CODE>-n</CODE>,
117 <CODE>--comments</CODE>
118 <DD>
119 Output any comments that were in the input document instance.
120 <DT>
121 <CODE>-r</CODE>,
122 <CODE>--raw</CODE>
123 <DD>
124 Raw output.
125 Don't perform any conversion on RSs and REs when printing the entity.
126 The entity would typically have the storage manager attribute
127 <SAMP>records=asis</SAMP>.
128 <DT>
129 <CODE>-R</CODE>,
130 <CODE>--restricted</CODE>
131 <DD>
132 This has the same effect as in <A HREF="nsgmls.htm#optR">onsgmls</A>.
133 <DT>
134 <CODE>-v</CODE>,
135 <CODE>--version</CODE>
136 <DD>
137 Print the version number.
138 <DT>
139 <CODE>-w<VAR>type</VAR></CODE>,
140 <CODE>--warning=<VAR>type</VAR></CODE>
141 <DD>
142 Control warnings and errors according to
143 <CODE><VAR>type</VAR></CODE>.
144 This has the same effect as in <A HREF="nsgmls.htm#optw">onsgmls</A>.
145 </DL>
146 </BODY>
147 </HTML>