1OSPAM(1) Reference OSPAM(1)
2
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 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 The following options are available:
29 -aname, --activate=name
31 Make doctype or linktype name active.
32 -Aarchitecture, --architecture=architecture
34 Parse with respect to architecture architecture.
35 -bbctf, --bctf=bctf
37 Use bctf bctf for output.
38 -csysid, --catalog=sysid
40 Use the catalog entry file sysid.
41 -C, --catalogs
43 This has the same effect as in onsgmls(1).
44 -Ddirectory, --directory=directory
46 Search directory for files specified in system identifiers. This
47 has the same effect as in onsgmls(1).
48 -e, --open-entities
50 Describe open entities in error messages.
51 -Emax_errors, --max-errors=max_errors
53 Exit after max_errors errors are encountered.
54 -ffile, --error-file=file
56 Redirect errors to file. This is useful mainly with shells that do
57 not support redirection of stderr.
58 -h, --hoist-omitted-tags
60 Hoist omitted tags out from the start of internal entities. If the
61 text at the beginning of an internal entity causes a tag to be
62 implied, the tag will usually be treated as being in that internal
63 entity; this option will instead cause it to be treated as being in
64 the entity that referenced the internal entity. This option makes a
65 difference in conjunction with -momittag or -x -x.
66 --help
68 Display a help text and exit.
69 -iname, --include=name
71 This has the same effect as in onsgmls(1).
72 -l, --lowercase
74 Prefer lower-case. Added names that were subject to upper-case
75 substitution will be converted to lower-case.
76 -mmarkup_option, --markup-option=markup_option
78 Change the markup in the output according to the value of
79 markup_option as follows:
80 omittag Add tags that were omitted using omitted tag minimization.
82 End tags that were omitted because the element has a declared
83 content of EMPTY or an explicit content reference will not be
84 added.
85 shortref Replace short references by named entity references.
87 net Change null end-tags into unminimized end-tags, and change
89 net-enabling start-tags into unminimized start-tags.
90 emptytag Change empty tags into unminimized tags.
92 unclosed Change unclosed tags into unminimized tags.
94 attname Add omitted attribute names and vis.
96 attvalue Add literal delimiters omitted from attribute values.
98 attspec Add omitted attribute specifications.
100 current Add omitted attribute specifications for current
102 attributes. This option is implied by the attspec option.
103 shorttag Equivalent to combination of net, emptytag, unclosed,
105 attname, attvalue and attspec options.
106 rank Add omitted rank suffixes.
108 reserved Put reserved names in upper-case.
110 ms Remove marked section declarations whose effective status is
112 IGNORE, and replace each marked section declaration whose effective
113 status is INCLUDE by its marked section. In the document instance,
114 empty comments will be added before or after the marked section
115 declaration to ensure that ignored record ends remain ignored.
116 Multiple -m options are allowed.
118 -n, --error-numbers
120 Show error numbers in error messages.
121 -oname, --output-entity=name
123 Output the general entity name instead of the document entity. The
124 output will correspond to the first time that the entity is
125 referenced in content.
126 -p, --output-prolog
128 Output the part of the document entity containing the SGML
129 declaration (if it was explicitly present in the document entity)
130 and the prolog before anything else. If this option is specified
131 two or more times, then all entity references occurring between
132 declarations in the prolog will be expanded; this includes the
133 implicit reference to the entity containing the external subset of
134 the DTD, if there is one. Note that the SGML declaration will not
135 be included if it was specified by an SGMLDECL entry in a catalog.
136 -r, --raw
138 Don't perform any conversion on RSs and REs when outputting the
139 entity. The entity would typically have the storage manager
140 attribute records=asis.
141 -R, --restricted
143 This as the same effect as in onsgmls(1)
144 -v, --version
146 Print the version number.
147 -wtype, --warning=type
149 Control warnings and errors according to type. This has the same
150 effect as in onsgmls(1).
151 -x, --expand-references
153 Expand references to entities that are changed. If this option is
154 specified two or more times, then all references to entities that
155 contain tags will be expanded.
156
158 Omitted tags are added at the point where they are implied by the SGML
159 parser (except as modified by the -h option); this is often not quite
160 where they are wanted.
161 The case of general delimiters is not preserved.
163 Incorrect results may be produced if a variant concrete syntax is used
165 which is such that there are delimiters in markup to be added that have
166 a prefix that is a proper suffix of some other delimiter.
167 If an entity reference in a default value uses the default entity and
169 an entity with that name is subsequently defined and that default value
170 is added to the document instance, then the resulting document may not
171 be equivalent to the original document. ospam will give a warning when
172 the first two conditions are met.
173
175 onsgmls(1), ospent(1), onsgmlnorm(1), osx(1)
176
178 James Clark
179 Author.
180 Ian Castle <ian.castle@openjade.org>
182 Author.
183
185OpenJade November 2002 OSPAM(1)