<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>The Kerberos Documentation Set — MIT Kerberos Documentation</title>
<link rel="stylesheet" href="_static/agogo.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/kerb.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '1.11.4',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="author" title="About these documents" href="#" />
<link rel="copyright" title="Copyright" href="copyright.html" />
<link rel="top" title="MIT Kerberos Documentation" href="index.html" />
<link rel="next" title="Resources" href="resources.html" />
<link rel="prev" title="How to build this documentation from the source" href="build_this.html" />
</head>
<body>
<div class="header-wrapper">
<div class="header" style="padding-bottom: 0px;">
<h1><a href="index.html"
style="color: #5d1509; font-size: 120%;
padding-top: 10px;">MIT Kerberos Documentation</a></h1>
<div class="rel">
<a href="index.html"
title="Full Table of Contents"
accesskey="C">Contents</a>
|
<a href="build_this.html"
title="How to build this documentation from the source"
accesskey="P">previous</a>
|
<a href="resources.html"
title="Resources"
accesskey="N">next</a>
|
<a href="genindex.html"
title="General Index"
accesskey="I">index</a>
|
<a href="search.html"
title="Enter search criteria"
accesskey="S">Search</a>
|
<a href="mailto:krb5-bugs@mit.edu?subject=Documentation__The Kerberos Documentation Set">feedback</a>
</div>
</div>
</div>
<div class="content-wrapper">
<div class="content">
<div class="sidebar"
style="float: right; background: #F9F9F9">
<h2>On this page </h2>
<ul>
<li><a class="reference internal" href="#">The Kerberos Documentation Set</a><ul>
<li><a class="reference internal" href="#background">Background</a></li>
<li><a class="reference internal" href="#feedback-and-comments">Feedback and Comments</a></li>
</ul>
</li>
</ul>
<br/>
<h2>Table of contents</h2>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="user/index.html">For users</a></li>
<li class="toctree-l1"><a class="reference internal" href="admin/index.html">For administrators</a></li>
<li class="toctree-l1"><a class="reference internal" href="appdev/index.html">For application developers</a></li>
<li class="toctree-l1"><a class="reference internal" href="plugindev/index.html">For plugin module developers</a></li>
<li class="toctree-l1"><a class="reference internal" href="build/index.html">Building Kerberos V5</a></li>
<li class="toctree-l1"><a class="reference internal" href="basic/index.html">Kerberos V5 concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="mitK5features.html">MIT Kerberos features</a></li>
<li class="toctree-l1"><a class="reference internal" href="build_this.html">How to build this documentation from the source</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="">The Kerberos Documentation Set</a><ul class="simple">
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="resources.html">Resources</a></li>
</ul>
<br/>
<h4><a href="index.html">Full Table of Contents
</a></h4>
<h4>Search</h4>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="the-kerberos-documentation-set">
<h1>The Kerberos Documentation Set<a class="headerlink" href="#the-kerberos-documentation-set" title="Permalink to this headline">¶</a></h1>
<div class="section" id="background">
<h2>Background<a class="headerlink" href="#background" title="Permalink to this headline">¶</a></h2>
<p>Starting with release 1.11, the Kerberos documentation set is
unified in a central form. Man pages, HTML documentation, and PDF
documents are compiled from reStructuredText sources, and the application
developer documentation incorporates Doxygen markup from the source
tree. This project was undertaken along the outline described at
<a class="reference external" href="http://k5wiki.kerberos.org/wiki/Projects/Kerberos_Documentation">http://k5wiki.kerberos.org/wiki/Projects/Kerberos_Documentation</a> .</p>
<p>Previous versions of Kerberos 5 attempted to maintain separate documentation
in the texinfo format, with separate groff manual pages. Having the API
documentation disjoint from the source code implementing that API
resulted in the documentation becoming stale, and over time the documentation
ceased to match reality. With a fresh start and a source format that is
easier to use and maintain, reStructuredText-based documents should provide
an improved experience for the user. Consolidating all the documentation
formats into a single source document makes the documentation set easier
to maintain.</p>
</div>
<div class="section" id="feedback-and-comments">
<h2>Feedback and Comments<a class="headerlink" href="#feedback-and-comments" title="Permalink to this headline">¶</a></h2>
<p>At the moment, comments should be sent via email to
<a class="reference external" href="mailto:krb5-bugs%40mit.edu">krb5-bugs<span>@</span>mit<span>.</span>edu</a>.</p>
<p>The HTML version of this documentation has a “FEEDBACK” link
(at the bottom of every page) to the <a class="reference external" href="mailto:krb5-bugs%40mit.edu">krb5-bugs<span>@</span>mit<span>.</span>edu</a> email address
with a pre-constructed subject line.</p>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="clearer" ></div>
</div>
</div>
<div class="footer-wrapper" >
<div class="footer" >
<div class="right" ><i>Release: 1.11.4</i><br />
© <a href="copyright.html">Copyright</a> 1985-2013, MIT.
</div>
<div class="left" >
<a href="index.html"
title="Full Table of Contents"
>Contents</a>
|
<a href="build_this.html"
title="How to build this documentation from the source"
>previous</a>
|
<a href="resources.html"
title="Resources"
>next</a>
|
<a href="genindex.html"
title="General Index"
>index</a>
|
<a href="search.html"
title="Enter search criteria"
>Search</a>
|
<a href="mailto:krb5-bugs@mit.edu?subject=Documentation__The Kerberos Documentation Set">feedback</a>
</div>
</div>
</div>
</body>
</html>
