1OSPAM(1) Reference OSPAM(1)
2
3
4
6 ospam - An SGML/XML markup stream editor
7
9 ospam [-CeghilprRvx] [-alinktype] [-Aarchitecture] [-bbctf]
10 [-ccatalog_file] [-Ddirectory] [-ffile] [-mmarkup_option]
11 [-oentity_name] [-wwarning_type] [sysid...]
12
14 ospam (OpenSP Add Markup) is an SGML markup stream editor implemented
15 using the OpenSP parser. ospam parses the SGML document contained in
16 sysid and copies to the standard output the portion of the document
17 entity containing the document instance, adding or changing markup as
18 specified by the -m options. The -p option can be used to include the
19 SGML declaration and prolog in the output. The -o option can be used to
20 output other entities. The -x option can be used to expand entity
21 references.
22
23 Part of an SGML System Conforming to International Standard ISO 8879 --
24 Standard Generalized Markup Language. An SGML Extended Facilities
25 system conforming to Annex A of Internation Standard ISO/IEC 10744 --
26 Hypermedia/Time-based Structuring Language.
27
28 The following options are available:
29
30 -aname, --activate=name
31 Make doctype or linktype name active.
32
33 -Aarchitecture, --architecture=architecture
34 Parse with respect to architecture architecture.
35
36 -bbctf, --bctf=bctf
37 Use bctf bctf for output.
38
39 -csysid, --catalog=sysid
40 Use the catalog entry file sysid.
41
42 -C, --catalogs
43 This has the same effect as in onsgmls(1).
44
45 -Ddirectory, --directory=directory
46 Search directory for files specified in system identifiers. This
47 has the same effect as in onsgmls(1).
48
49 -e, --open-entities
50 Describe open entities in error messages.
51
52 -Emax_errors, --max-errors=max_errors
53 Exit after max_errors errors are encountered.
54
55 -ffile, --error-file=file
56 Redirect errors to file. This is useful mainly with shells that do
57 not support redirection of stderr.
58
59 -g, --open-elements
60 Show the generic identifiers of open elements in error messages.
61
62 -h, --hoist-omitted-tags
63 Hoist omitted tags out from the start of internal entities. If the
64 text at the beginning of an internal entity causes a tag to be
65 implied, the tag will usually be treated as being in that internal
66 entity; this option will instead cause it to be treated as being in
67 the entity that referenced the internal entity. This option makes a
68 difference in conjunction with -momittag or -x -x.
69
70 --help
71 Display a help text and exit.
72
73 -iname, --include=name
74 This has the same effect as in onsgmls(1).
75
76 -l, --lowercase
77 Prefer lower-case. Added names that were subject to upper-case
78 substitution will be converted to lower-case.
79
80 -mmarkup_option, --markup-option=markup_option
81 Change the markup in the output according to the value of
82 markup_option as follows:
83
84 omittag Add tags that were omitted using omitted tag minimization.
85 End tags that were omitted because the element has a declared
86 content of EMPTY or an explicit content reference will not be
87 added.
88
89 shortref Replace short references by named entity references.
90
91 net Change null end-tags into unminimized end-tags, and change
92 net-enabling start-tags into unminimized start-tags.
93
94 emptytag Change empty tags into unminimized tags.
95
96 unclosed Change unclosed tags into unminimized tags.
97
98 attname Add omitted attribute names and vis.
99
100 attvalue Add literal delimiters omitted from attribute values.
101
102 attspec Add omitted attribute specifications.
103
104 current Add omitted attribute specifications for current
105 attributes. This option is implied by the attspec option.
106
107 shorttag Equivalent to combination of net, emptytag, unclosed,
108 attname, attvalue and attspec options.
109
110 rank Add omitted rank suffixes.
111
112 reserved Put reserved names in upper-case.
113
114 ms Remove marked section declarations whose effective status is
115 IGNORE, and replace each marked section declaration whose effective
116 status is INCLUDE by its marked section. In the document instance,
117 empty comments will be added before or after the marked section
118 declaration to ensure that ignored record ends remain ignored.
119
120 Multiple -m options are allowed.
121
122 -n, --error-numbers
123 Show error numbers in error messages.
124
125 -oname, --output-entity=name
126 Output the general entity name instead of the document entity. The
127 output will correspond to the first time that the entity is
128 referenced in content.
129
130 -p, --output-prolog
131 Output the part of the document entity containing the SGML
132 declaration (if it was explicitly present in the document entity)
133 and the prolog before anything else. If this option is specified
134 two or more times, then all entity references occurring between
135 declarations in the prolog will be expanded; this includes the
136 implicit reference to the entity containing the external subset of
137 the DTD, if there is one. Note that the SGML declaration will not
138 be included if it was specified by an SGMLDECL entry in a catalog.
139
140 -r, --raw
141 Don't perform any conversion on RSs and REs when outputting the
142 entity. The entity would typically have the storage manager
143 attribute records=asis.
144
145 -R, --restricted
146 This as the same effect as in onsgmls(1)
147
148 -v, --version
149 Print the version number.
150
151 -wtype, --warning=type
152 Control warnings and errors according to type. This has the same
153 effect as in onsgmls(1).
154
155 -x, --expand-references
156 Expand references to entities that are changed. If this option is
157 specified two or more times, then all references to entities that
158 contain tags will be expanded.
159
161 Omitted tags are added at the point where they are implied by the SGML
162 parser (except as modified by the -h option); this is often not quite
163 where they are wanted.
164
165 The case of general delimiters is not preserved.
166
167 Incorrect results may be produced if a variant concrete syntax is used
168 which is such that there are delimiters in markup to be added that have
169 a prefix that is a proper suffix of some other delimiter.
170
171 If an entity reference in a default value uses the default entity and
172 an entity with that name is subsequently defined and that default value
173 is added to the document instance, then the resulting document may not
174 be equivalent to the original document. ospam will give a warning when
175 the first two conditions are met.
176
178 onsgmls(1), ospent(1), onsgmlnorm(1), osx(1)
179
181 James Clark
182 Author.
183
184 Ian Castle <ian.castle@openjade.org>
185 Author.
186
188OpenJade November 2002 OSPAM(1)