sam-t2/devtools/v9/html/python/doc/tools-internal.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="doc.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index' />
<link rel="first" href="doc.html" title='Documenting Python' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="cygwin.html" />
<link rel="prev" href="tools-external.html" />
<link rel="parent" href="tools.html" />
<link rel="next" href="cygwin.html" />
<meta name='aesop' content='information' />
<title>7.2 Internal Tools </title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="7.1 External Tools"
  href="tools-external.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="7 Processing Tools"
  href="tools.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="7.3 Working on Cygwin"
  href="cygwin.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Documenting Python</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><img src='../icons/blank.png'
  border='0' height='32'  alt='' width='32' /></td>
<td class='online-navigation'><img src='../icons/blank.png'
  border='0' height='32'  alt='' width='32' /></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="tools-external.html">7.1 External Tools</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="tools.html">7 Processing Tools</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="cygwin.html">7.3 Working on Cygwin</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H2><A NAME="SECTION000820000000000000000"></A><A NAME="tools-internal"></A>
<BR>
7.2 Internal Tools
</H2>

<P>
This section describes the various scripts that are used to
    implement various stages of document processing or to orchestrate
    entire build sequences.  Most of these tools are only useful
    in the context of building the standard documentation, but some
    are more general.

<P>
<DL>
<DT><STRONG><b class="program">mkhowto</b></STRONG></DT>
<DD>This is the primary script used to format third-party
        documents.  It contains all the logic needed to ``get it
        right.''  The proper way to use this script is to make a
        symbolic link to it or run it in place; the actual script file
        must be stored as part of the documentation source tree,
        though it may be used to format documents outside the tree.
        Use <b class="program">mkhowto</b> <b class="programopt">--help</b> for a list of
        command line options.

<P>
<b class="program">mkhowto</b> can be used for both <code>howto</code> and
        <code>manual</code> class documents.  It is usually a good idea to
        always use the latest version of this tool rather than a
        version from an older source release of Python.  It can be
        used to generate DVI, HTML, PDF, PostScript, and plain text
        documents.  The GNU info and iSilo formats will be supported
        by this script in some future version.

<P>
Use the <b class="programopt">--help</b> option on this script's command
        line to get a summary of options for this script.

<P>
XXX  Need more here.

</DD>
</DL>

<P>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="7.1 External Tools"
  href="tools-external.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="7 Processing Tools"
  href="tools.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="7.3 Working on Cygwin"
  href="cygwin.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Documenting Python</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><img src='../icons/blank.png'
  border='0' height='32'  alt='' width='32' /></td>
<td class='online-navigation'><img src='../icons/blank.png'
  border='0' height='32'  alt='' width='32' /></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="tools-external.html">7.1 External Tools</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="tools.html">7 Processing Tools</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="cygwin.html">7.3 Working on Cygwin</A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>