source: pst/typesetting/jadetex.xml@ 0aeb696

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
   "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

    <!-- Inserted as a reminder to do this. The mention of a test suite
         is usually right before the root user installation commands. Please
         delete these 12 (including one blank) lines after you are done.-->

    <!-- Use one of the two mentions below about a test suite,
         delete the line that is not applicable. Of course, if the
         test suite uses syntax other than "make check", revise the
         line to reflect the actual syntax to run the test suite -->

    <!-- <para>This package does not come with a test suite.</para> -->
    <!-- <para>To test the results, issue: <command>make check</command>.</para> -->

  <!ENTITY jadetex-download-http "http://prdownloads.sourceforge.net/jadetex/jadetex-&jadetex-version;.tar.gz">
  <!ENTITY jadetex-download-ftp  "ftp://ftp.fu-berlin.de/unix/linux/mirrors/gentoo/distfiles/jadetex-&jadetex-version;.tar.gz">
  <!ENTITY jadetex-md5sum        "634dfc172fbf66a6976e2c2c60e2d198">
  <!ENTITY jadetex-size          "103 KB">
  <!ENTITY jadetex-buildsize     "9.3 MB">
  <!ENTITY jadetex-time          "less than 0.1 SBU">
]>

<sect1 id="jadetex" xreflabel="JadeTeX-&jadetex-version;">
  <?dbhtml filename="jadetex.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">jadetex-&jadetex-version;.tar</keyword>
      <keyword role="ftpdir">jadetex</keyword>
    </keywordset>
  </sect1info>

  <title>JadeTeX-&jadetex-version;</title>

  <indexterm zone="jadetex">
    <primary sortas="a-JadeTeX">JadeTeX</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to JadeTeX</title>

    <para>The <application>JadeTeX</application> package is a companion package
    to the <application>OpenJade</application> DSSSL processor.
    <application>JadeTeX</application> transforms high level LaTeX macros into
    DVI/PostScript and Portable Document Format (PDF) forms.</para>

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&jadetex-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&jadetex-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &jadetex-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &jadetex-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &jadetex-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &jadetex-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing='compact'>
      <listitem>
        <para>Recommended demo files: <ulink
        url="&sources-anduin-http;/j/jadetex-3.13-demo.tar.bz2"/>
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">JadeTeX Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="tex"/> and
    <xref linkend="openjade"/></para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/jadetex"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of JadeTeX</title>

    <para>If you downloaded the demo files tarball, unpack it along with the
    source tarball. It will unpack as a
    <filename class='directory'>demo</filename> directory in the root of the
    source tree.</para>

    <para>First, as the <systemitem class="username">root</systemitem> user,
    make some required modifications to the <filename>texmf.cnf</filename>
    file already installed on the system by the <application>TeX</application>
    package, then build a new <filename>latex.fmt</filename> file using the
    following commands:</para>

<screen role="root"><userinput>sed -i.orig -e "s/original texmf.cnf/modified texmf.cnf/" \
            -e "s/memory hog.../&amp;\npool_size.context = 750000/" \
    $(kpsewhich texmf.cnf) &amp;&amp;
cat &gt;&gt; $(kpsewhich texmf.cnf) &lt;&lt; "EOF"
<literal>
% The following 3 sections added for JadeTeX

% latex settings
main_memory.latex = 1100000
param_size.latex = 1500
stack_size.latex = 1500
hash_extra.latex = 15000
string_vacancies.latex = 45000
pool_free.latex = 47500
nest_size.latex = 500
save_size.latex = 5000
pool_size.latex = 500000
max_strings.latex = 55000
font_mem_size.latex= 400000

% jadetex settings
main_memory.jadetex = 1500000
param_size.jadetex = 1500
stack_size.jadetex = 1500
hash_extra.jadetex = 50000
string_vacancies.jadetex = 45000
pool_free.jadetex = 47500
nest_size.jadetex = 500
save_size.jadetex = 5000
pool_size.jadetex = 500000
max_strings.jadetex = 55000

% pdfjadetex settings
main_memory.pdfjadetex = 2500000
param_size.pdfjadetex = 1500
stack_size.pdfjadetex = 1500
hash_extra.pdfjadetex = 50000
string_vacancies.pdfjadetex = 45000
pool_free.pdfjadetex = 47500
nest_size.pdfjadetex = 500
save_size.pdfjadetex = 5000
pool_size.pdfjadetex = 500000
max_strings.pdfjadetex = 55000
</literal>
EOF
LATEX_FMT_DIR="$(kpsewhich -expand-var '$TEXMFSYSVAR')/web2c" &amp;&amp;
mv -v $(kpsewhich latex.fmt) $(kpsewhich latex.fmt).orig &amp;&amp;
mv -v $LATEX_FMT_DIR/latex.log $LATEX_FMT_DIR/latex.log.orig &amp;&amp;
fmtutil-sys --byfmt latex</userinput></screen>

    <para>Install <application>JadeTex</application> using the following
    commands:</para>

<screen><userinput>make</userinput></screen>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>install -v -m755 -d \
    $(kpsewhich -expand-var '$TEXMFLOCAL')/tex/jadetex/config &amp;&amp;
install -v -m644 dsssl.def jadetex.ltx *.sty \
    $(kpsewhich -expand-var '$TEXMFLOCAL')/tex/jadetex &amp;&amp;
install -v -m644 {,pdf}jadetex.ini \
    $(kpsewhich -expand-var '$TEXMFLOCAL')/tex/jadetex/config &amp;&amp;
FMTUTIL_CNF="$(kpsewhich fmtutil.cnf)" &amp;&amp;
mv $FMTUTIL_CNF $FMTUTIL_CNF.orig &amp;&amp;
cat $FMTUTIL_CNF.orig - &gt;&gt; $FMTUTIL_CNF &lt;&lt; "EOF"
<literal>
# JadeTeX formats:
jadetex         etex            -               "&amp;latex"     jadetex.ini
pdfjadetex      pdfetex         -               "&amp;pdflatex"  pdfjadetex.ini
</literal>
EOF
mv -v $(kpsewhich -expand-var '$TEXMFMAIN')/ls-R \
      $(kpsewhich -expand-var '$TEXMFMAIN')/ls-R.orig &amp;&amp;
mv -v $(kpsewhich -expand-var '$TEXMFSYSVAR')/ls-R \
      $(kpsewhich -expand-var '$TEXMFSYSVAR')/ls-R.orig &amp;&amp;
mktexlsr &amp;&amp;
fmtutil-sys --byfmt jadetex &amp;&amp;
fmtutil-sys --byfmt pdfjadetex &amp;&amp;
mktexlsr &amp;&amp;
ln -v -sf etex /usr/bin/jadetex &amp;&amp;
ln -v -sf pdfetex /usr/bin/pdfjadetex &amp;&amp;
install -v -m644 -D index.html \
    /usr/share/doc/jadetex-&jadetex-version;/index.html &amp;&amp;
install -v -m644 *.1 /usr/share/man/man1</userinput></screen>

    <para>If you downloaded the demo files tarball, issue the following
    commands as an unprivileged user to test the functionality of the new
    <application>JadeTex</application> installation:</para>

<screen><userinput>cd demo &amp;&amp;
openjade -t tex -d demo.dsl demo.sgm &amp;&amp;
jadetex demo.tex &amp;&amp;
pdfjadetex demo.tex &amp;&amp;
ls -lrt &amp;&amp;
cd ..</userinput></screen>

    <para>The commands should complete without errors or warnings and create
    <filename>demo.dvi</filename> and <filename>demo.pdf</filename> files.</para>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><command>sed -i -e ... -e ... $(kpsewhich texmf.cnf)</command>:
    This command uses <command>kpsewhich</command> to locate the installed
    <filename>texmf.cnf</filename>. The first change is used to modify the
    header of the file so that if <application>TeX</application> is upgraded,
    the file won't get overwritten. The next change adds a parameter to
    increase ConTeXt's memory size to accommodate
    <application>JadeTeX</application>.</para>

    <para><command>fmtutil-sys ...</command>: These commands are used to build
    the <filename>latex.fmt</filename>, <filename>jadetex.fmt</filename> and
    <filename>pdfjadetex.fmt</filename> files. Additionally, the command
    automagically places the files in the correct directory.</para>

    <para><command>mktexlsr; ln -v -sf tex ...; ln -v -sf pdftex ...</command>:
    The <application>JadeTeX</application> programs are actually just symlinks
    to the <application>TeX</application> programs. <command>mktexlsr</command>
    updates <application>TeX</application>'s <filename>ls-R</filename> databases
    used by the <filename class='libraryfile'>libkpathsea</filename> library so
    that <application>TeX</application> knows to use the
    <application>JadeTeX</application> <filename>.fmt</filename> files when
    <command>jadetex</command> or <command>pdfjadetex</command> is called.</para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring JadeTeX</title>

    <sect3>
      <title>Config Files</title>

      <para><filename>jadetex.dtx</filename> in the
      <application>JadeTeX</application> source tree.</para>

    </sect3>

    <sect3>
      <title>Configuration Information</title>

      <para>If you need to modify the default <application>JadeTeX</application>
      macro settings, see the
      <ulink url="http://jadetex.sourceforge.net/#index-div-d18e397">
      <application>JadeTeX</application> FAQ</ulink>.</para>

    </sect3>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>jadetex and pdfjadetex</seg>
        <seg>None</seg>
        <seg>/usr/share/texmf-local and
        /usr/share/doc/jadetex-&jadetex-version;</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="jadetex-prog">
        <term><command>jadetex</command></term>
        <listitem>
          <para>transforms LaTeX macros created by
          <application>OpenJade</application> into DVI/PostScript forms.</para>
          <indexterm zone="jadetex jadetex-prog">
            <primary sortas="b-jadetex">jadetex</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pdfjadetex">
        <term><command>pdfjadetex</command></term>
        <listitem>
          <para>transforms LaTeX macros created by
          <application>OpenJade</application> into Portable Document Format
          (PDF) forms.</para>
          <indexterm zone="jadetex pdfjadetex">
            <primary sortas="b-pdfjadetex">pdfjadetex</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>