<?xml version="1.0" encoding="ISO-8859-1" standalone="no"?>
<!DOCTYPE MAN SYSTEM "../../manrev.dtd">
<MAN>
  <LANGUAGE>eng</LANGUAGE>
  <TITLE>formatman</TITLE>
  <TYPE>Scilab Function</TYPE>
  <DATE>january 2001</DATE>
  <SHORT_DESCRIPTION name="formatman"> translates old NROFF man files in a directory into ascii, tex, html or xml</SHORT_DESCRIPTION>
  <CALLING_SEQUENCE>
    <CALLING_SEQUENCE_ITEM>formatman(path [,to])  </CALLING_SEQUENCE_ITEM>
  </CALLING_SEQUENCE>
  <PARAM>
    <PARAM_INDENT>
      <PARAM_ITEM>
        <PARAM_NAME>path</PARAM_NAME>
        <PARAM_DESCRIPTION>
          <SP>: character string, giving the path of the directory</SP>
        </PARAM_DESCRIPTION>
      </PARAM_ITEM>
      <PARAM_ITEM>
        <PARAM_NAME>to</PARAM_NAME>
        <PARAM_DESCRIPTION>
          <SP>: character string with possible values &quot;ascii&quot;, &quot;tex&quot;, &quot;html&quot;, &quot;xml&quot;</SP>
        </PARAM_DESCRIPTION>
      </PARAM_ITEM>
    </PARAM_INDENT>
  </PARAM>
  <DESCRIPTION>
    <P>
    This function, not yet fully checked, formats old help files (*.man) of a given
    directory, written
    in a subset of NROFF, to ascii, tex, html or xml.
  </P>
    <P>
    NOTE: this function is obsolete and MUST ONLY be used to translate old
    NROFF help files into new XML help files.
  </P>
    <P>
    Known NROFF directives are .TH, .SH, .TP, .RS, .RE, .LP, .IG,
     .nf, .fi, .TS, .TE, .ft, .IP
  </P>
    <P>
    Font handling like
  </P>
    <VERBATIM>
<![CDATA[
, , , , ,  ]
   ]]>
    </VERBATIM>
    <P>
    are ignored
  </P>
    <DESCRIPTION_INDENT>
      <DESCRIPTION_ITEM label="ascii">
        <SP>mode generates a .cat file for each .man file and a whatis file</SP>
      </DESCRIPTION_ITEM>
      <DESCRIPTION_ITEM label="tex">
        <SP>mode generates a .tex file for each .man file and a whatis.tex file</SP>
      </DESCRIPTION_ITEM>
      <DESCRIPTION_ITEM label="html">
        <SP>mode generates a .html file for each .man file and a index.html file</SP>
      </DESCRIPTION_ITEM>
      <DESCRIPTION_ITEM label="xml">
        <SP>mode generates a .xml file for each .man file</SP>
      </DESCRIPTION_ITEM>
    </DESCRIPTION_INDENT>
  </DESCRIPTION>
  <SEE_ALSO>
    <SEE_ALSO_ITEM>
      <LINK>help</LINK>
    </SEE_ALSO_ITEM>
    <SEE_ALSO_ITEM>
      <LINK>man</LINK>
    </SEE_ALSO_ITEM>
  </SEE_ALSO>
</MAN>
