1*7f2fe78bSCy Schubert 2*7f2fe78bSCy Schubert<!DOCTYPE html> 3*7f2fe78bSCy Schubert 4*7f2fe78bSCy Schubert<html> 5*7f2fe78bSCy Schubert <head> 6*7f2fe78bSCy Schubert <meta charset="utf-8" /> 7*7f2fe78bSCy Schubert <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> 8*7f2fe78bSCy Schubert 9*7f2fe78bSCy Schubert <title>Contributing to the MIT Kerberos Documentation — MIT Kerberos Documentation</title> 10*7f2fe78bSCy Schubert <link rel="stylesheet" type="text/css" href="_static/pygments.css" /> 11*7f2fe78bSCy Schubert <link rel="stylesheet" type="text/css" href="_static/agogo.css" /> 12*7f2fe78bSCy Schubert <link rel="stylesheet" type="text/css" href="_static/kerb.css" /> 13*7f2fe78bSCy Schubert <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script> 14*7f2fe78bSCy Schubert <script src="_static/jquery.js"></script> 15*7f2fe78bSCy Schubert <script src="_static/underscore.js"></script> 16*7f2fe78bSCy Schubert <script src="_static/doctools.js"></script> 17*7f2fe78bSCy Schubert <link rel="author" title="About these documents" href="#" /> 18*7f2fe78bSCy Schubert <link rel="index" title="Index" href="genindex.html" /> 19*7f2fe78bSCy Schubert <link rel="search" title="Search" href="search.html" /> 20*7f2fe78bSCy Schubert <link rel="copyright" title="Copyright" href="copyright.html" /> 21*7f2fe78bSCy Schubert <link rel="next" title="Resources" href="resources.html" /> 22*7f2fe78bSCy Schubert <link rel="prev" title="How to build this documentation from the source" href="build_this.html" /> 23*7f2fe78bSCy Schubert </head><body> 24*7f2fe78bSCy Schubert <div class="header-wrapper"> 25*7f2fe78bSCy Schubert <div class="header"> 26*7f2fe78bSCy Schubert 27*7f2fe78bSCy Schubert 28*7f2fe78bSCy Schubert <h1><a href="index.html">MIT Kerberos Documentation</a></h1> 29*7f2fe78bSCy Schubert 30*7f2fe78bSCy Schubert <div class="rel"> 31*7f2fe78bSCy Schubert 32*7f2fe78bSCy Schubert <a href="index.html" title="Full Table of Contents" 33*7f2fe78bSCy Schubert accesskey="C">Contents</a> | 34*7f2fe78bSCy Schubert <a href="build_this.html" title="How to build this documentation from the source" 35*7f2fe78bSCy Schubert accesskey="P">previous</a> | 36*7f2fe78bSCy Schubert <a href="resources.html" title="Resources" 37*7f2fe78bSCy Schubert accesskey="N">next</a> | 38*7f2fe78bSCy Schubert <a href="genindex.html" title="General Index" 39*7f2fe78bSCy Schubert accesskey="I">index</a> | 40*7f2fe78bSCy Schubert <a href="search.html" title="Enter search criteria" 41*7f2fe78bSCy Schubert accesskey="S">Search</a> | 42*7f2fe78bSCy Schubert <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__Contributing to the MIT Kerberos Documentation">feedback</a> 43*7f2fe78bSCy Schubert </div> 44*7f2fe78bSCy Schubert </div> 45*7f2fe78bSCy Schubert </div> 46*7f2fe78bSCy Schubert 47*7f2fe78bSCy Schubert <div class="content-wrapper"> 48*7f2fe78bSCy Schubert <div class="content"> 49*7f2fe78bSCy Schubert <div class="document"> 50*7f2fe78bSCy Schubert 51*7f2fe78bSCy Schubert <div class="documentwrapper"> 52*7f2fe78bSCy Schubert <div class="bodywrapper"> 53*7f2fe78bSCy Schubert <div class="body" role="main"> 54*7f2fe78bSCy Schubert 55*7f2fe78bSCy Schubert <section id="contributing-to-the-mit-kerberos-documentation"> 56*7f2fe78bSCy Schubert<h1>Contributing to the MIT Kerberos Documentation<a class="headerlink" href="#contributing-to-the-mit-kerberos-documentation" title="Permalink to this headline">¶</a></h1> 57*7f2fe78bSCy Schubert<p>We are looking for documentation writers and editors who could contribute 58*7f2fe78bSCy Schuberttowards improving the MIT KC documentation content. If you are an experienced 59*7f2fe78bSCy SchubertKerberos developer and/or administrator, please consider sharing your knowledge 60*7f2fe78bSCy Schubertand experience with the Kerberos Community. You can suggest your own topic or 61*7f2fe78bSCy Schubertwrite about any of the topics listed 62*7f2fe78bSCy Schubert<a class="reference external" href="https://k5wiki.kerberos.org/wiki/Projects/Documentation_Tasks">here</a>.</p> 63*7f2fe78bSCy Schubert<p>If you have any questions, comments, or suggestions on the existing documents, 64*7f2fe78bSCy Schubertplease send your feedback via email to <a class="reference external" href="mailto:krb5-bugs%40mit.edu">krb5-bugs<span>@</span>mit<span>.</span>edu</a>. The HTML version of 65*7f2fe78bSCy Schubertthis documentation has a “FEEDBACK” link to the <a class="reference external" href="mailto:krb5-bugs%40mit.edu">krb5-bugs<span>@</span>mit<span>.</span>edu</a> email 66*7f2fe78bSCy Schubertaddress with a pre-constructed subject line.</p> 67*7f2fe78bSCy Schubert<section id="background"> 68*7f2fe78bSCy Schubert<h2>Background<a class="headerlink" href="#background" title="Permalink to this headline">¶</a></h2> 69*7f2fe78bSCy Schubert<p>Starting with release 1.11, the Kerberos documentation set is 70*7f2fe78bSCy Schubertunified in a central form. Man pages, HTML documentation, and PDF 71*7f2fe78bSCy Schubertdocuments are compiled from reStructuredText sources, and the application 72*7f2fe78bSCy Schubertdeveloper documentation incorporates Doxygen markup from the source 73*7f2fe78bSCy Schuberttree. This project was undertaken along the outline described 74*7f2fe78bSCy Schubert<a class="reference external" href="https://k5wiki.kerberos.org/wiki/Projects/Kerberos_Documentation">here</a>.</p> 75*7f2fe78bSCy Schubert<p>Previous versions of Kerberos 5 attempted to maintain separate documentation 76*7f2fe78bSCy Schubertin the texinfo format, with separate groff manual pages. Having the API 77*7f2fe78bSCy Schubertdocumentation disjoint from the source code implementing that API 78*7f2fe78bSCy Schubertresulted in the documentation becoming stale, and over time the documentation 79*7f2fe78bSCy Schubertceased to match reality. With a fresh start and a source format that is 80*7f2fe78bSCy Schuberteasier to use and maintain, reStructuredText-based documents should provide 81*7f2fe78bSCy Schubertan improved experience for the user. Consolidating all the documentation 82*7f2fe78bSCy Schubertformats into a single source document makes the documentation set easier 83*7f2fe78bSCy Schubertto maintain.</p> 84*7f2fe78bSCy Schubert</section> 85*7f2fe78bSCy Schubert</section> 86*7f2fe78bSCy Schubert 87*7f2fe78bSCy Schubert 88*7f2fe78bSCy Schubert <div class="clearer"></div> 89*7f2fe78bSCy Schubert </div> 90*7f2fe78bSCy Schubert </div> 91*7f2fe78bSCy Schubert </div> 92*7f2fe78bSCy Schubert </div> 93*7f2fe78bSCy Schubert <div class="sidebar"> 94*7f2fe78bSCy Schubert 95*7f2fe78bSCy Schubert <h2>On this page</h2> 96*7f2fe78bSCy Schubert <ul> 97*7f2fe78bSCy Schubert<li><a class="reference internal" href="#">Contributing to the MIT Kerberos Documentation</a><ul> 98*7f2fe78bSCy Schubert<li><a class="reference internal" href="#background">Background</a></li> 99*7f2fe78bSCy Schubert</ul> 100*7f2fe78bSCy Schubert</li> 101*7f2fe78bSCy Schubert</ul> 102*7f2fe78bSCy Schubert 103*7f2fe78bSCy Schubert <br/> 104*7f2fe78bSCy Schubert <h2>Table of contents</h2> 105*7f2fe78bSCy Schubert <ul class="current"> 106*7f2fe78bSCy Schubert<li class="toctree-l1"><a class="reference internal" href="user/index.html">For users</a></li> 107*7f2fe78bSCy Schubert<li class="toctree-l1"><a class="reference internal" href="admin/index.html">For administrators</a></li> 108*7f2fe78bSCy Schubert<li class="toctree-l1"><a class="reference internal" href="appdev/index.html">For application developers</a></li> 109*7f2fe78bSCy Schubert<li class="toctree-l1"><a class="reference internal" href="plugindev/index.html">For plugin module developers</a></li> 110*7f2fe78bSCy Schubert<li class="toctree-l1"><a class="reference internal" href="build/index.html">Building Kerberos V5</a></li> 111*7f2fe78bSCy Schubert<li class="toctree-l1"><a class="reference internal" href="basic/index.html">Kerberos V5 concepts</a></li> 112*7f2fe78bSCy Schubert<li class="toctree-l1"><a class="reference internal" href="formats/index.html">Protocols and file formats</a></li> 113*7f2fe78bSCy Schubert<li class="toctree-l1"><a class="reference internal" href="mitK5features.html">MIT Kerberos features</a></li> 114*7f2fe78bSCy Schubert<li class="toctree-l1"><a class="reference internal" href="build_this.html">How to build this documentation from the source</a></li> 115*7f2fe78bSCy Schubert<li class="toctree-l1 current"><a class="current reference internal" href="#">Contributing to the MIT Kerberos Documentation</a></li> 116*7f2fe78bSCy Schubert<li class="toctree-l1"><a class="reference internal" href="resources.html">Resources</a></li> 117*7f2fe78bSCy Schubert</ul> 118*7f2fe78bSCy Schubert 119*7f2fe78bSCy Schubert <br/> 120*7f2fe78bSCy Schubert <h4><a href="index.html">Full Table of Contents</a></h4> 121*7f2fe78bSCy Schubert <h4>Search</h4> 122*7f2fe78bSCy Schubert <form class="search" action="search.html" method="get"> 123*7f2fe78bSCy Schubert <input type="text" name="q" size="18" /> 124*7f2fe78bSCy Schubert <input type="submit" value="Go" /> 125*7f2fe78bSCy Schubert <input type="hidden" name="check_keywords" value="yes" /> 126*7f2fe78bSCy Schubert <input type="hidden" name="area" value="default" /> 127*7f2fe78bSCy Schubert </form> 128*7f2fe78bSCy Schubert 129*7f2fe78bSCy Schubert </div> 130*7f2fe78bSCy Schubert <div class="clearer"></div> 131*7f2fe78bSCy Schubert </div> 132*7f2fe78bSCy Schubert </div> 133*7f2fe78bSCy Schubert 134*7f2fe78bSCy Schubert <div class="footer-wrapper"> 135*7f2fe78bSCy Schubert <div class="footer" > 136*7f2fe78bSCy Schubert <div class="right" ><i>Release: 1.21.3</i><br /> 137*7f2fe78bSCy Schubert © <a href="copyright.html">Copyright</a> 1985-2024, MIT. 138*7f2fe78bSCy Schubert </div> 139*7f2fe78bSCy Schubert <div class="left"> 140*7f2fe78bSCy Schubert 141*7f2fe78bSCy Schubert <a href="index.html" title="Full Table of Contents" 142*7f2fe78bSCy Schubert >Contents</a> | 143*7f2fe78bSCy Schubert <a href="build_this.html" title="How to build this documentation from the source" 144*7f2fe78bSCy Schubert >previous</a> | 145*7f2fe78bSCy Schubert <a href="resources.html" title="Resources" 146*7f2fe78bSCy Schubert >next</a> | 147*7f2fe78bSCy Schubert <a href="genindex.html" title="General Index" 148*7f2fe78bSCy Schubert >index</a> | 149*7f2fe78bSCy Schubert <a href="search.html" title="Enter search criteria" 150*7f2fe78bSCy Schubert >Search</a> | 151*7f2fe78bSCy Schubert <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__Contributing to the MIT Kerberos Documentation">feedback</a> 152*7f2fe78bSCy Schubert </div> 153*7f2fe78bSCy Schubert </div> 154*7f2fe78bSCy Schubert </div> 155*7f2fe78bSCy Schubert 156*7f2fe78bSCy Schubert </body> 157*7f2fe78bSCy Schubert</html>