"Fossies" - the Fresh Open Source Software Archive

Member "krb5-1.18/doc/html/build_this.html" (12 Feb 2020, 12042 Bytes) of package /linux/misc/krb5-1.18.tar.gz:


The requested HTML page contains a <FORM> tag that is unusable on "Fossies" in "automatic" (rendered) mode so that page is shown as HTML source code syntax highlighting (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 
    2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    3   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    4 
    5 <html xmlns="http://www.w3.org/1999/xhtml">
    6   <head>
    7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    8     <title>How to build this documentation from the source &#8212; MIT Kerberos Documentation</title>
    9     <link rel="stylesheet" href="_static/agogo.css" type="text/css" />
   10     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
   11     <link rel="stylesheet" href="_static/kerb.css" type="text/css" />
   12     <script type="text/javascript">
   13       var DOCUMENTATION_OPTIONS = {
   14         URL_ROOT:    './',
   15         VERSION:     '1.18',
   16         COLLAPSE_INDEX: false,
   17         FILE_SUFFIX: '.html',
   18         HAS_SOURCE:  true,
   19         SOURCELINK_SUFFIX: '.txt'
   20       };
   21     </script>
   22     <script type="text/javascript" src="_static/jquery.js"></script>
   23     <script type="text/javascript" src="_static/underscore.js"></script>
   24     <script type="text/javascript" src="_static/doctools.js"></script>
   25     <link rel="author" title="About these documents" href="about.html" />
   26     <link rel="index" title="Index" href="genindex.html" />
   27     <link rel="search" title="Search" href="search.html" />
   28     <link rel="copyright" title="Copyright" href="copyright.html" />
   29     <link rel="next" title="Contributing to the MIT Kerberos Documentation" href="about.html" />
   30     <link rel="prev" title="Copyright" href="copyright.html" /> 
   31   </head>
   32   <body>
   33     <div class="header-wrapper">
   34         <div class="header">
   35             
   36             
   37             <h1><a href="index.html">MIT Kerberos Documentation</a></h1>
   38             
   39             <div class="rel">
   40                 
   41         <a href="index.html" title="Full Table of Contents"
   42             accesskey="C">Contents</a> |
   43         <a href="copyright.html" title="Copyright"
   44             accesskey="P">previous</a> |
   45         <a href="about.html" title="Contributing to the MIT Kerberos Documentation"
   46             accesskey="N">next</a> |
   47         <a href="genindex.html" title="General Index"
   48             accesskey="I">index</a> |
   49         <a href="search.html" title="Enter search criteria"
   50             accesskey="S">Search</a> |
   51     <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__How to build this documentation from the source">feedback</a>
   52             </div>
   53         </div>
   54     </div>
   55 
   56     <div class="content-wrapper">
   57       <div class="content">
   58         <div class="document">
   59             
   60       <div class="documentwrapper">
   61         <div class="bodywrapper">
   62           <div class="body" role="main">
   63             
   64   <div class="section" id="how-to-build-this-documentation-from-the-source">
   65 <h1>How to build this documentation from the source<a class="headerlink" href="#how-to-build-this-documentation-from-the-source" title="Permalink to this headline"></a></h1>
   66 <p>Pre-requisites for a simple build, or to update man pages:</p>
   67 <ul class="simple">
   68 <li>Sphinx 1.0.4 or higher (See <a class="reference external" href="https://www.sphinx-doc.org">https://www.sphinx-doc.org</a>) with the
   69 autodoc extension installed.</li>
   70 </ul>
   71 <p>Additional prerequisites to include the API reference based on Doxygen
   72 markup:</p>
   73 <ul class="simple">
   74 <li>Python 2.5 with the Cheetah, lxml, and xml modules</li>
   75 <li>Doxygen</li>
   76 </ul>
   77 <div class="section" id="simple-build-without-api-reference">
   78 <h2>Simple build without API reference<a class="headerlink" href="#simple-build-without-api-reference" title="Permalink to this headline"></a></h2>
   79 <p>To test simple changes to the RST sources, you can build the
   80 documentation without the Doxygen reference by running, from the doc
   81 directory:</p>
   82 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">sphinx</span><span class="o">-</span><span class="n">build</span> <span class="o">.</span> <span class="n">test_html</span>
   83 </pre></div>
   84 </div>
   85 <p>You will see a number of warnings about missing files.  This is
   86 expected.  If there is not already a <code class="docutils literal"><span class="pre">doc/version.py</span></code> file, you will
   87 need to create one by first running <code class="docutils literal"><span class="pre">make</span> <span class="pre">version.py</span></code> in the
   88 <code class="docutils literal"><span class="pre">src/doc</span></code> directory of a configured build tree.</p>
   89 </div>
   90 <div class="section" id="updating-man-pages">
   91 <h2>Updating man pages<a class="headerlink" href="#updating-man-pages" title="Permalink to this headline"></a></h2>
   92 <p>Man pages are generated from the RST sources and checked into the
   93 <code class="docutils literal"><span class="pre">src/man</span></code> directory of the repository.  This allows man pages to be
   94 installed without requiring Sphinx when using a source checkout.  To
   95 regenerate these files, run <code class="docutils literal"><span class="pre">make</span> <span class="pre">man</span></code> from the man subdirectory
   96 of a configured build tree.  You can also do this from an unconfigured
   97 source tree with:</p>
   98 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">src</span><span class="o">/</span><span class="n">man</span>
   99 <span class="n">make</span> <span class="o">-</span><span class="n">f</span> <span class="n">Makefile</span><span class="o">.</span><span class="ow">in</span> <span class="n">top_srcdir</span><span class="o">=..</span> <span class="n">srcdir</span><span class="o">=.</span> <span class="n">man</span>
  100 <span class="n">make</span> <span class="n">clean</span>
  101 </pre></div>
  102 </div>
  103 <p>As with the simple build, it is normal to see warnings about missing
  104 files when rebuilding the man pages.</p>
  105 </div>
  106 <div class="section" id="building-for-a-release-tarball-or-web-site">
  107 <h2>Building for a release tarball or web site<a class="headerlink" href="#building-for-a-release-tarball-or-web-site" title="Permalink to this headline"></a></h2>
  108 <p>To generate documentation in HTML format, run <code class="docutils literal"><span class="pre">make</span> <span class="pre">html</span></code> in the
  109 <code class="docutils literal"><span class="pre">doc</span></code> subdirectory of a configured build tree (the build directory
  110 corresponding to <code class="docutils literal"><span class="pre">src/doc</span></code>, not the top-level <code class="docutils literal"><span class="pre">doc</span></code> directory).
  111 The output will be placed in the top-level <code class="docutils literal"><span class="pre">doc/html</span></code> directory.
  112 This build will include the API reference generated from Doxygen
  113 markup in the source tree.</p>
  114 <p>Documentation generated this way will use symbolic names for paths
  115 (like <code class="docutils literal"><span class="pre">BINDIR</span></code> for the directory containing user programs), with the
  116 symbolic names being links to a table showing typical values for those
  117 paths.</p>
  118 <p>You can also do this from an unconfigured source tree with:</p>
  119 <div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">cd</span> <span class="n">src</span><span class="o">/</span><span class="n">doc</span>
  120 <span class="n">make</span> <span class="o">-</span><span class="n">f</span> <span class="n">Makefile</span><span class="o">.</span><span class="ow">in</span> <span class="n">SPHINX_ARGS</span><span class="o">=</span> <span class="n">htmlsrc</span>
  121 </pre></div>
  122 </div>
  123 </div>
  124 <div class="section" id="building-for-an-os-package-or-site-documentation">
  125 <h2>Building for an OS package or site documentation<a class="headerlink" href="#building-for-an-os-package-or-site-documentation" title="Permalink to this headline"></a></h2>
  126 <p>To generate documentation specific to a build of MIT krb5 as you have
  127 configured it, run <code class="docutils literal"><span class="pre">make</span> <span class="pre">substhtml</span></code> in the <code class="docutils literal"><span class="pre">doc</span></code> subdirectory of a
  128 configured build tree (the build directory corresponding to
  129 <code class="docutils literal"><span class="pre">src/doc</span></code>, not the top-level <code class="docutils literal"><span class="pre">doc</span></code> directory).  The output will be
  130 placed in the <code class="docutils literal"><span class="pre">html_subst</span></code> subdirectory of that build directory.
  131 This build will include the API reference.</p>
  132 <p>Documentation generated this way will use concrete paths (like
  133 <code class="docutils literal"><span class="pre">/usr/local/bin</span></code> for the directory containing user programs, for a
  134 default custom build).</p>
  135 </div>
  136 </div>
  137 
  138 
  139           </div>
  140         </div>
  141       </div>
  142         </div>
  143         <div class="sidebar">
  144     <h2>On this page</h2>
  145     <ul>
  146 <li><a class="reference internal" href="#">How to build this documentation from the source</a><ul>
  147 <li><a class="reference internal" href="#simple-build-without-api-reference">Simple build without API reference</a></li>
  148 <li><a class="reference internal" href="#updating-man-pages">Updating man pages</a></li>
  149 <li><a class="reference internal" href="#building-for-a-release-tarball-or-web-site">Building for a release tarball or web site</a></li>
  150 <li><a class="reference internal" href="#building-for-an-os-package-or-site-documentation">Building for an OS package or site documentation</a></li>
  151 </ul>
  152 </li>
  153 </ul>
  154 
  155     <br/>
  156     <h2>Table of contents</h2>
  157     <ul class="current">
  158 <li class="toctree-l1"><a class="reference internal" href="user/index.html">For users</a></li>
  159 <li class="toctree-l1"><a class="reference internal" href="admin/index.html">For administrators</a></li>
  160 <li class="toctree-l1"><a class="reference internal" href="appdev/index.html">For application developers</a></li>
  161 <li class="toctree-l1"><a class="reference internal" href="plugindev/index.html">For plugin module developers</a></li>
  162 <li class="toctree-l1"><a class="reference internal" href="build/index.html">Building Kerberos V5</a></li>
  163 <li class="toctree-l1"><a class="reference internal" href="basic/index.html">Kerberos V5 concepts</a></li>
  164 <li class="toctree-l1"><a class="reference internal" href="formats/index.html">Protocols and file formats</a></li>
  165 <li class="toctree-l1"><a class="reference internal" href="mitK5features.html">MIT Kerberos features</a></li>
  166 <li class="toctree-l1 current"><a class="current reference internal" href="#">How to build this documentation from the source</a></li>
  167 <li class="toctree-l1"><a class="reference internal" href="about.html">Contributing to the MIT Kerberos Documentation</a></li>
  168 <li class="toctree-l1"><a class="reference internal" href="resources.html">Resources</a></li>
  169 </ul>
  170 
  171     <br/>
  172     <h4><a href="index.html">Full Table of Contents</a></h4>
  173     <h4>Search</h4>
  174     <form class="search" action="search.html" method="get">
  175       <input type="text" name="q" size="18" />
  176       <input type="submit" value="Go" />
  177       <input type="hidden" name="check_keywords" value="yes" />
  178       <input type="hidden" name="area" value="default" />
  179     </form>
  180         </div>
  181         <div class="clearer"></div>
  182       </div>
  183     </div>
  184 
  185     <div class="footer-wrapper">
  186         <div class="footer" >
  187             <div class="right" ><i>Release: 1.18</i><br />
  188                 &copy; <a href="copyright.html">Copyright</a> 1985-2019, MIT.
  189             </div>
  190             <div class="left">
  191                 
  192         <a href="index.html" title="Full Table of Contents"
  193             >Contents</a> |
  194         <a href="copyright.html" title="Copyright"
  195             >previous</a> |
  196         <a href="about.html" title="Contributing to the MIT Kerberos Documentation"
  197             >next</a> |
  198         <a href="genindex.html" title="General Index"
  199             >index</a> |
  200         <a href="search.html" title="Enter search criteria"
  201             >Search</a> |
  202     <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__How to build this documentation from the source">feedback</a>
  203             </div>
  204         </div>
  205     </div>
  206 
  207   </body>
  208 </html>