actual/packages/node-libofx/OpenSP-1.5.2/docsrc/ospent.xml

<?xml version='1.0'?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
 "/usr/share/sgml/docbook/xml-dtd-4.1.2/docbookx.dtd">
<article>
  <articleinfo>
    <title>ospent</title>
    <author>
      <firstname>James</firstname>
      <surname>Clark</surname>
    </author>
    <author>
      <firstname>Ian</firstname>
      <surname>Castle</surname>
      <affiliation><address><email>ian.castle@openjade.org</email></address></affiliation>
    </author>
  
    <copyright>
      <year>2002</year>
      <holder>OpenJade Project</holder>
    </copyright>
  </articleinfo>

                                       
  <section>
    <title>Reference</title>

    <refentry>
      <refentryinfo>
        <title>ospent</title>
        <date>November 2002</date>
        <productname>OpenJade</productname>
      </refentryinfo>

      <refmeta>
        <refentrytitle>ospent</refentrytitle>
        <manvolnum>1</manvolnum>
      </refmeta>

      <refnamediv>
        <refname>ospent</refname>
        <refpurpose>Concatenates entities in an SGML/XML document</refpurpose>
      </refnamediv>
    
      <refsynopsisdiv>
        <cmdsynopsis>
          <command>ospent</command>
          <arg choice="opt"><option>-ChnrRv</option></arg>
          <arg choice="opt"><option>-b<replaceable>bctf</replaceable></option></arg>
          <arg choice="opt"><option>-c<replaceable>sysid</replaceable></option></arg>
          <arg choice="opt"><option>-f<replaceable>file</replaceable></option></arg>
          <arg choice="opt"><option>-D<replaceable>directory</replaceable></option></arg>
          <arg rep="repeat"><replaceable>sysid</replaceable></arg>
        </cmdsynopsis>
      </refsynopsisdiv>
<!--
   spent [ -Cnrv ] [ -bbctf ] [ -Ddirectory ] sysid...
-->
   
      <refsect1>
        <title>Description</title>

   <para><command>ospent</command> (OpenSP print entity) prints the concatenation of the entities
   with system identifiers <cmdsynopsis><arg rep="repeat"><replaceable>sysid</replaceable></arg></cmdsynopsis> on the standard output.</para>
   
   <para>The following options are available:</para>

   <variablelist>
     <varlistentry>
     <term><option>-b<replaceable>bctf</replaceable></option></term>
     <term><option>--bctf=<replaceable>bctf</replaceable></option></term>
     <listitem>
          <para>Use the BCTF with name <replaceable>bctf</replaceable> for output.</para>
     </listitem>
     </varlistentry>

     <varlistentry>
       <term><option>-c<replaceable>sysid</replaceable></option></term>
       <term><option>--catalog=<replaceable>sysid</replaceable></option></term>
       <listitem>
          <para>Map public identifiers and entity names to system identifiers
          using the catalog entry file whose system identifier is 
          <replaceable>sysid</replaceable>.</para>
       </listitem>
     </varlistentry>
     <varlistentry>
       <term><option>-C</option></term>
       <term><option>--catalogs</option></term>
       <listitem>
          <para>This has the same effect as in <command>onsgmls(1)</command>.</para>
       </listitem>
     </varlistentry>

     <varlistentry>
       <term><option>-D<replaceable>directory</replaceable></option></term>
       <term><option>--directory=<replaceable>directory</replaceable></option></term>
       <listitem>
          <para>Search directory for files specified in system identifiers.
          This has the same effect as in <command>onsgmls(1)</command>.</para>
       </listitem>
     </varlistentry>

     <varlistentry>
       <term><option>-f<replaceable>file</replaceable></option></term>
       <term><option>--error-file=<replaceable>file</replaceable></option></term>
       <listitem>
          <para>Redirect error messages to <replaceable>file</replaceable>.</para>
       </listitem>
     </varlistentry>

     <varlistentry>
       <term><option>-h</option></term>
       <term><option>--help</option></term>
       <listitem>
          <para>Display a help text and exit.</para>
       </listitem>
     </varlistentry>

     <varlistentry>
       <term><option>-n</option></term>
       <term><option>--non-sgml</option></term>
       <listitem>
         <para>The entity is a non-SGML data entity. This option forces the
          octets in the storage objects comprising the entity to be
          copied exactly without any of the conversions that are done for
          text entities. Implies <option>-r</option>.</para>
       </listitem>
     </varlistentry>

     <varlistentry>
       <term><option>-r</option></term>
       <term><option>--raw</option></term>
       <listitem>
          <para>Raw output. Don't perform any conversion on RSs and REs when
          printing the entity. The entity would typically have the
          storage manager attribute records=asis.</para>
       </listitem>
     </varlistentry>

     <varlistentry>
       <term><option>-R</option></term>
       <term><option>--restricted</option></term>
       <listitem>
          <para>This has the same effect as in <command>onsgmls(1)</command>.</para>
       </listitem>
     </varlistentry>

     <varlistentry>
       <term><option>-v</option></term>
       <term><option>--version</option></term>
       <listitem>
          <para>Print the version number.</para>
       </listitem>
     </varlistentry>
   </variablelist>

   </refsect1>

   <refsect1>
     <title>See Also</title>
     <para><command>onsgmls(1)</command>, <command>ospam(1)</command>,
     <command>onsgmlnorm(1)</command>, <command>osx(1)</command></para>
   </refsect1>

   </refentry>
   </section>
</article>