"Fossies" - the Fresh Open Source Software Archive

Member "OpenSP-1.5.2/docsrc/ospam.xml" (8 Dec 2005, 14871 Bytes) of package /linux/misc/old/OpenSP-1.5.2.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) XML source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 <?xml version='1.0'?>
    2 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
    3  "/usr/share/sgml/docbook/xml-dtd-4.1.2/docbookx.dtd">
    4 <article>
    5   <articleinfo>
    6     <title>ospam</title>
    7     <author>
    8       <firstname>James</firstname>
    9       <surname>Clark</surname>
   10     </author>
   11     <author>
   12       <firstname>Ian</firstname>
   13       <surname>Castle</surname>
   14       <affiliation><address><email>ian.castle@openjade.org</email></address></affiliation>
   15     </author>
   16   
   17     <copyright>
   18       <year>2002</year>
   19       <holder>OpenJade Project</holder>
   20     </copyright>
   21   </articleinfo>
   22 
   23                                        
   24   <section>
   25     <title>Reference</title>
   26 
   27     <refentry>
   28       <refentryinfo>
   29         <title>ospam</title>
   30         <date>November 2002</date>
   31         <productname>OpenJade</productname>
   32       </refentryinfo>
   33 
   34       <refmeta>
   35         <refentrytitle>ospam</refentrytitle>
   36         <manvolnum>1</manvolnum>
   37       </refmeta>
   38 
   39       <refnamediv>
   40         <refname>ospam</refname>
   41     <refpurpose>An SGML/XML markup stream editor</refpurpose>
   42       </refnamediv>
   43     
   44       <refsynopsisdiv>
   45         <cmdsynopsis>
   46           <command>ospam</command>
   47           <arg choice="opt"><option>-CeghilprRvx</option></arg>
   48           <arg choice="opt"><option>-a<replaceable>linktype</replaceable></option></arg>
   49           <arg choice="opt"><option>-A<replaceable>architecture</replaceable></option></arg>
   50           <arg choice="opt"><option>-b<replaceable>bctf</replaceable></option></arg>
   51           <arg choice="opt"><option>-c<replaceable>catalog_file</replaceable></option></arg>
   52           <arg choice="opt"><option>-D<replaceable>directory</replaceable></option></arg>
   53           <arg choice="opt"><option>-f<replaceable>file</replaceable></option></arg>
   54           <arg choice="opt"><option>-m<replaceable>markup_option</replaceable></option></arg>
   55           <arg choice="opt"><option>-o<replaceable>entity_name</replaceable></option></arg>
   56           <arg choice="opt"><option>-w<replaceable>warning_type</replaceable></option></arg>
   57           <arg rep="repeat"><replaceable>sysid</replaceable></arg>
   58 <!--
   59    spam [ -Cehilprvx ] [ -ccatalog_file ] [ -Ddirectory ] [ -ffile ] [
   60    -mmarkup_option ] [ -oentity_name ] [ -wwarning_type ] sysid...
   61 -->
   62         </cmdsynopsis>
   63       </refsynopsisdiv>
   64 
   65       <refsect1>
   66         <title>Description</title>
   67 
   68    <para><command>ospam</command> (OpenSP Add Markup) is an SGML markup stream editor implemented using
   69    the OpenSP parser. <command>ospam</command> parses the SGML document contained in <replaceable>sysid</replaceable> and
   70    copies to the standard output the portion of the document entity
   71    containing the document instance, adding or changing markup as
   72    specified by the <option>-m</option> options. The <option>-p</option> option can be used to include the
   73    SGML declaration and prolog in the output. The <option>-o</option> option can be used
   74    to output other entities. The <option>-x</option> option can be used to expand entity
   75    references.</para>
   76    
   77    <para>Part of an SGML System Conforming to International Standard ISO 8879 -- Standard Generalized Markup Language. An SGML Extended Facilities system conforming to Annex A of Internation Standard ISO/IEC 10744 -- Hypermedia/Time-based Structuring Language.</para>
   78 
   79    <para>The following options are available:</para>
   80    
   81    <variablelist>
   82      <varlistentry>
   83        <term><option>-a<replaceable>name</replaceable></option></term>
   84        <term><option>--activate=<replaceable>name</replaceable></option></term>
   85        <listitem>
   86           <para>Make doctype or linktype <replaceable>name</replaceable> active.</para>
   87        </listitem>
   88      </varlistentry>
   89 
   90      <varlistentry>
   91        <term><option>-A<replaceable>architecture</replaceable></option></term>
   92        <term><option>--architecture=<replaceable>architecture</replaceable></option></term>
   93        <listitem>
   94           <para>Parse with respect to architecture <replaceable>architecture</replaceable>.</para>
   95        </listitem>
   96      </varlistentry>
   97 
   98      <varlistentry>
   99        <term><option>-b<replaceable>bctf</replaceable></option></term>
  100        <term><option>--bctf=<replaceable>bctf</replaceable></option></term>
  101        <listitem>
  102           <para>Use bctf <replaceable>bctf</replaceable> for output.</para>
  103        </listitem>
  104      </varlistentry>
  105 
  106      <varlistentry>
  107        <term><option>-c<replaceable>sysid</replaceable></option></term>
  108        <term><option>--catalog=<replaceable>sysid</replaceable></option></term>
  109        <listitem>
  110           <para>Use the catalog entry file <replaceable>sysid</replaceable>.</para>
  111        </listitem>
  112      </varlistentry>
  113 
  114      <varlistentry>
  115        <term><option>-C</option></term>
  116        <term><option>--catalogs</option></term>
  117        <listitem>
  118           <para>This has the same effect as in <command>onsgmls(1)</command>.</para>
  119        </listitem>
  120      </varlistentry>
  121 
  122      <varlistentry>
  123        <term><option>-D<replaceable>directory</replaceable></option></term>
  124        <term><option>--directory=<replaceable>directory</replaceable></option></term>
  125        <listitem>
  126           <para>Search directory for files specified in system identifiers.
  127           This has the same effect as in <command>onsgmls(1)</command>.</para>
  128        </listitem>
  129      </varlistentry>
  130      <varlistentry>
  131        <term><option>-e</option></term>
  132        <term><option>--open-entities</option></term>
  133        <listitem>
  134           <para>Describe open entities in error messages.</para>
  135        </listitem>
  136      </varlistentry>
  137 
  138      <varlistentry>
  139        <term><option>-E<replaceable>max_errors</replaceable></option></term>
  140        <term><option>--max-errors=<replaceable>max_errors</replaceable></option></term>
  141        <listitem>
  142           <para>Exit after <replaceable>max_errors</replaceable> errors are encountered.</para>
  143        </listitem>
  144      </varlistentry>
  145      <varlistentry>
  146        <term><option>-f<replaceable>file</replaceable></option></term>
  147        <term><option>--error-file=<replaceable>file</replaceable></option></term>
  148        <listitem>
  149           <para>Redirect errors to <replaceable>file</replaceable>.
  150           This is useful mainly with shells that do not support redirection
  151           of stderr.</para>
  152        </listitem>
  153      </varlistentry>
  154      <varlistentry>
  155        <term><option>-h</option></term>
  156        <term><option>--hoist-omitted-tags</option></term>
  157        <listitem>
  158           <para>Hoist omitted tags out from the start of internal entities. If
  159           the text at the beginning of an internal entity causes a tag to
  160           be implied, the tag will usually be treated as being in that
  161           internal entity; this option will instead cause it to be
  162           treated as being in the entity that referenced the internal
  163           entity. This option makes a difference in conjunction with
  164           <option>-momittag</option> or <option>-x</option> <option>-x</option>.</para>
  165        </listitem>
  166      </varlistentry>
  167 
  168      <varlistentry>
  169        <term><option>--help</option></term>
  170        <listitem>
  171           <para>Display a help text and exit.</para>
  172        </listitem>
  173      </varlistentry>
  174 
  175      <varlistentry>
  176        <term><option>-i<replaceable>name</replaceable></option></term>
  177        <term><option>--include=<replaceable>name</replaceable></option></term>
  178        <listitem>
  179           <para>This has the same effect as in <command>onsgmls(1)</command>.</para>
  180        </listitem>
  181      </varlistentry>
  182           
  183      <varlistentry>
  184        <term><option>-l</option></term>
  185        <term><option>--lowercase</option></term>
  186        <listitem>
  187          <para>Prefer lower-case. Added names that were subject to upper-case
  188           substitution will be converted to lower-case.</para>
  189        </listitem>
  190      </varlistentry>
  191 
  192      <varlistentry>
  193        <term><option>-m<replaceable>markup_option</replaceable></option></term>
  194        <term><option>--markup-option=<replaceable>markup_option</replaceable></option></term>
  195        <listitem>
  196           <para>Change the markup in the output according to the value of
  197           <replaceable>markup_option</replaceable> as follows:</para>
  198           
  199         <para><option>omittag</option>
  200                 Add tags that were omitted using omitted tag
  201                 minimization. End tags that were omitted because the
  202                 element has a declared content of EMPTY or an explicit
  203                 content reference will not be added.</para>
  204                 
  205         <para><option>shortref</option>
  206                 Replace short references by named entity references.</para>
  207                 
  208         <para><option>net</option>
  209                 Change null end-tags into unminimized end-tags, and
  210                 change net-enabling start-tags into unminimized
  211                 start-tags.</para>
  212                 
  213         <para><option>emptytag</option>
  214                 Change empty tags into unminimized tags.</para>
  215                 
  216         <para><option>unclosed</option>
  217                 Change unclosed tags into unminimized tags.</para>
  218                 
  219         <para><option>attname</option>
  220                 Add omitted attribute names and vis.</para>
  221                 
  222         <para><option>attvalue</option>
  223                 Add literal delimiters omitted from attribute values.</para>
  224                 
  225         <para><option>attspec</option>
  226                 Add omitted attribute specifications.</para>
  227                 
  228         <para><option>current</option>
  229                 Add omitted attribute specifications for current
  230                 attributes. This option is implied by the attspec option.</para>
  231                 
  232         <para><option>shorttag</option>
  233                 Equivalent to combination of net, emptytag, unclosed,
  234                 attname, attvalue and attspec options.</para>
  235                 
  236         <para><option>rank</option>
  237                 Add omitted rank suffixes.</para>
  238                 
  239         <para><option>reserved</option>
  240                 Put reserved names in upper-case.</para>
  241                 
  242         <para><option>ms</option>
  243                 Remove marked section declarations whose effective status
  244                 is IGNORE, and replace each marked section declaration
  245                 whose effective status is INCLUDE by its marked section.
  246                 In the document instance, empty comments will be added
  247                 before or after the marked section declaration to ensure
  248                 that ignored record ends remain ignored.</para>
  249                 
  250           <para>Multiple -m options are allowed.</para>
  251        </listitem>
  252      </varlistentry>
  253 
  254      <varlistentry>
  255        <term><option>-n</option></term>
  256        <term><option>--error-numbers</option></term>
  257        <listitem>
  258           <para>Show error numbers in error messages.</para>
  259        </listitem>
  260      </varlistentry>
  261 
  262      <varlistentry>
  263        <term><option>-o<replaceable>name</replaceable></option></term>
  264        <term><option>--output-entity=<replaceable>name</replaceable></option></term>
  265        <listitem>
  266           <para>Output the general entity name instead of the document entity.
  267           The output will correspond to the first time that the entity is
  268           referenced in content.</para>
  269        </listitem>
  270      </varlistentry>
  271 
  272      <varlistentry>
  273        <term><option>-p</option></term>
  274        <term><option>--output-prolog</option></term>
  275        <listitem>
  276           <para>Output the part of the document entity containing the SGML
  277           declaration (if it was explicitly present in the document
  278           entity) and the prolog before anything else. If this option is
  279           specified two or more times, then all entity references
  280           occurring between declarations in the prolog will be expanded;
  281           this includes the implicit reference to the entity containing
  282           the external subset of the DTD, if there is one. Note that the
  283           SGML declaration will not be included if it was specified by an
  284           SGMLDECL entry in a catalog.</para>
  285        </listitem>
  286      </varlistentry>
  287 
  288      <varlistentry>
  289        <term><option>-r</option></term>
  290        <term><option>--raw</option></term>
  291        <listitem>
  292           <para>Don't perform any conversion on RSs and REs when outputting the
  293           entity. The entity would typically have the storage manager
  294           attribute records=asis.</para>
  295        </listitem>
  296      </varlistentry>
  297           
  298      <varlistentry>
  299        <term><option>-R</option></term>
  300        <term><option>--restricted</option></term>
  301        <listitem>
  302           <para>This as the same effect as in <command>onsgmls(1)</command></para>
  303        </listitem>
  304      </varlistentry>
  305           
  306      <varlistentry>
  307        <term><option>-v</option></term>
  308        <term><option>--version</option></term>
  309        <listitem>
  310           <para>Print the version number.</para>
  311        </listitem>
  312      </varlistentry>
  313           
  314      <varlistentry>
  315        <term><option>-w<replaceable>type</replaceable></option></term>
  316        <term><option>--warning=<replaceable>type</replaceable></option></term>
  317        <listitem>
  318           <para>Control warnings and errors according to type. This has the
  319           same effect as in <command>onsgmls(1)</command>.</para>
  320        </listitem>
  321      </varlistentry>
  322           
  323      <varlistentry>
  324        <term><option>-x</option></term>
  325        <term><option>--expand-references</option></term>
  326        <listitem>
  327           <para>Expand references to entities that are changed. If this option
  328           is specified two or more times, then all references to entities
  329           that contain tags will be expanded.</para>
  330        </listitem>
  331      </varlistentry>
  332    </variablelist>
  333  </refsect1>
  334 
  335  <refsect1>
  336    <title>Bugs</title>
  337 
  338    <para>Omitted tags are added at the point where they are implied by the SGML
  339    parser (except as modified by the <option>-h</option> option); this is often not quite
  340    where they are wanted.</para>
  341    
  342    <para>The case of general delimiters is not preserved.</para>
  343    
  344    <para>Incorrect results may be produced if a variant concrete syntax is used
  345    which is such that there are delimiters in markup to be added that
  346    have a prefix that is a proper suffix of some other delimiter.</para>
  347    
  348    <para>If an entity reference in a default value uses the default entity and
  349    an entity with that name is subsequently defined and that default
  350    value is added to the document instance, then the resulting document
  351    may not be equivalent to the original document. <command>ospam</command> will give a
  352    warning when the first two conditions are met.</para>
  353 
  354    </refsect1>
  355    <refsect1>
  356      <title>See Also</title>
  357      <para><command>onsgmls(1)</command>, <command>ospent(1)</command>,
  358      <command>onsgmlnorm(1)</command>, <command>osx(1)</command></para>
  359    </refsect1>
  360  </refentry>
  361  </section>
  362 </article>