summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* Use en dash instead of hyphenBen Kaduk2012-11-271-1/+1
| | | | | | | | It should not be bracketed in whitespace. ticket: 7447 tags: pullup target_version: 1.11
* Remove Test Coverage topic from documentationZhanna Tsitkov2012-11-262-32/+0
| | | | ticket: 7464
* Move Release tag into footer for Sphinx HTMLZhanna Tsitkov2012-11-262-6/+2
| | | | | | | | The current position of the Release tag is in the body of the main page of the Sphinx html. Move it to the footer. This way the release number can be viewed from every page. ticket: 7462
* Update feature list in the documentationZhanna Tsitkov2012-11-261-77/+83
| | | | | | | | | | | | | | | In Quick facts section: - restructure the Supported platforms section; - do not tie KfW to 1.11 release; - move references to GSS-API extensions to Feature list table. In Feature list section: - reformat the table; - move PRNG and Pre-auth mechanisms into their own tables; - clarify GS2 feature description; - reference rfc6680 for GSS-API naming extensions. Lowercase the words in the title of the document. ticket: 7455
* Add "Kerberos" to PDF titlesTom Yu2012-11-191-4/+4
| | | | | | ticket: 7451 (new) tags: pullup target_version: 1.11
* Add Camellia enctypes to default enctype listsGreg Hudson2012-11-141-1/+1
| | | | | | | | | | | | Add camellia256-cts-cmas and camellia128-cts-cmac to the default permitted_enctypes, default_tkt_enctypes, and default_tgs_enctypes lists, to simplify deployment of Camellia. The new enctypes still aren't on supported_enctypes, so won't be in the set of long-term keys for principals without administrator intervention. ticket: 7446 (new) target_version: 1.11 tags: pullup
* Replace UTF-8 with ASCIIBen Kaduk2012-11-141-6/+6
| | | | | | | | | | | | | We try to restrict non-ASCII to names. Python does not accept U+2013 EN DASH as indicating a command-line argument; U+2D HYPHEN-MINUS is required. Replace U+201C LEFT DOUBLE QUOTATION MARK and U+201D RIGHT DOUBLE QUOTATION MARK with ordinary ASCII quotes. ticket: 7433 tags: pullup
* Rename doc subdirectoriesBen Kaduk2012-11-1467-77/+74
| | | | | | | | | | | | | | | | | | | | We like these names better, and they match the PDF document filenames. admins -> admin appldev -> appdev users -> user and catch up where the names are used elsewhere. The relay/ directory has been removed, with its contents moved to the top level in build_this.rst and a new about.rst. The section headers for kadmind, krb5kdc, sserver, kpasswd, kswitch, and sclient are misdetected as conflict markers. bigredbutton: whitespace ticket: 7433 tags: pullup
* Remove trailing whitespaceBen Kaduk2012-11-144-5/+0
| | | | | ticket: 7433 tags: pullup
* Use release, not version, for HTML indexBen Kaduk2012-11-141-1/+1
| | | | | | | | The full release string includes RELTAIL from patchlevel.h; it is useful to know whether we are on a pre- or post-release branch. ticket: 7433 tags: pullup
* Update conf.py for latex outputBen Kaduk2012-11-141-1/+8
| | | | | | | | | | | We do not want one giant PDF document; we want separate PDFs for our various components. The features document cannot be included in the list because the generated LaTeX for tables with empty cells does not compile. ticket: 7433 tags: pullup
* Use main conf.py for NOTICETom Yu2012-11-143-100/+21
| | | | | | | | | | Generate the NOTICE file using the main conf.py, by using a special tag when invoking sphinx-build. While here, add notice.txt to the list of files removed by make clean. ticket: 7433 tags: pullup
* Generate and use version.py for SphinxTom Yu2012-11-141-3/+8
| | | | | | | | | | | | Sphinx's idea of the version number appears in the man pages and compiled PDF documents, and shows up as metadata in the generated HTML sources. Extract the version information from the master source (patchlevel.h) into a form usable by Sphinx. ticket: 7433 tags: pullup
* Add Camellia to enctype table in documentationGreg Hudson2012-11-021-0/+3
| | | | | | ticket: 7439 (new) target_version: 1.11 tags: pullup
* Fix a typo in pkinit.rstGreg Hudson2012-11-021-1/+1
|
* Update Camellia feature descriptionTom Yu2012-11-011-1/+1
| | | | | | | | | | Remove the potentially misleading "experimental" annotation on the description of the Camellia encryption feature. Also update the I-D version to match the IESG-approved version. ticket: 7437 (new) target_version: 1.11 tags: pullup
* Document PKINIT and anonymos PKINIT configurationGreg Hudson2012-11-012-0/+220
| | | | | | ticket: 7436 (new) target_version: 1.11 tags: pullup
* Document GSSAPI loadable module interfaceGreg Hudson2012-10-253-5/+112
| | | | | | ticket: 7429 (new) target_version: 1.11 tags: pullup
* Add missing macro and type index.rst entriesGreg Hudson2012-10-232-0/+17
| | | | | | ticket: 7424 (new) target_version: 1.11 tags: pullup
* Document prompter and responder callbacksGreg Hudson2012-10-221-0/+85
|
* Fix kswitch section heading markupBen Kaduk2012-10-171-1/+1
| | | | | SYNOPSIS is a first-level section, and should use '-' like the other sections.
* Add docs for kinit's -I optionNalin Dahyabhai2012-10-171-0/+9
|
* Use bulleted instead of ordinal lists as neededBen Kaduk2012-10-171-26/+26
| | | | | The texinfo-generated NOTICE used bullets for some of the lists; make the RST source consistent with that.
* Add an input ccache get_init_creds optionNalin Dahyabhai2012-10-161-0/+1
| | | | | | | | Add a krb5_get_init_creds_opt_set_in_ccache() function. An input ccache may hold configuration data which the client libraries can use to influence their decisions. ticket: 7413 (new)
* Remove nroff man pagesBen Kaduk2012-10-161-1/+0
| | | | | | | We generate man pages from RST sources now; they are checked into the tree in src/man/. The gen-manpages directory is no longer needed.
* More RST rename follow-upBen Kaduk2012-10-163-28/+28
| | | | | | Update conf.py for paths to man page sources and update make rules for building the man pages. Correct README files for the location of the sources.
* Better doc the accepted values for kdc_timesyncZhanna Tsitkov2012-10-161-1/+1
|
* Modify MIT Kerberos Features documentZhanna Tsitkov2012-10-161-3/+4
|
* Catch up to RST move/renameBen Kaduk2012-10-152-10/+10
| | | | | | | | Change the make rules for the directory structure. Update the RST sources which include other RST sources for the loss of the krb_ prefix. ticket: 7409
* Massive reST content renameBen Kaduk2012-10-15102-0/+0
| | | | | | | | | | | All of rst_source/ is now just in doc/. The krb_ prefix is stripped from the document sub-directories. rst_tools are now just tools. The section headers of kadmind, krb5kdc, and sserver match as conflict markers. bigredbutton: whitespace ticket: 7409
* Whitespace cleanupBen Kaduk2012-10-1510-146/+146
| | | | Prior to a mass rename of the RST sources and utilities.
* Remove stale implement documentBen Kaduk2012-10-1513-1544/+0
| | | | | | | | As with the texinfo implementor's guide, it is sufficiently stale so as to be untrustworthy without verification. Content of this nature should live on k5wiki.kerberos.org. ticket: 7408
* Remove the last vestiges of the texinfo docsBen Kaduk2012-10-1511-12490/+0
| | | | | | | | | | | | | | We needed these last stragglers to build the NOTICE file at the root of the tree, but we now generate a notice.txt from reST. Man pages have been generated from reST for some time now, we no longer need scripts to turn them into HTML and ps, as those can be generated directly from the reST source. The Makefile only existed to serve the texinfo builds, so it goes away, too. (The tgz target appears to have been broken since 1996.) ticket: 7408
* Make rules for building NOTICE from RSTBen Kaduk2012-10-151-0/+88
| | | | | | | | | | | | | | | | | | | | Sphinx-build wants to scan over all the sources in the source dir, and its text output engine does not handle the spanning row cells used in some of our fancy tables, so it will crash if we attempt to generate text output from our full suite of documents. We could work around this by attempting to just compile the one source file as an additional argument to sphinx-build, but this seems to insist on producing an index.txt as well as a notice.txt. Furthermore, we cannot use the same conf.py as in rst_composite because the paths substitutions are not available with just the minimal contents of rst_notice. Make a copy and remove the irrelevant parts, for now, changing only the master_doc field as appropriate. For the HTML build, we use the standard |copy| macro from isonum.txt to get the unicode copyright symbol glyph, but for ASCII output we prefer to just use the literal "(C)". ticket: 7407
* Add notice.rstBen Kaduk2012-10-152-2/+1125
| | | | | | | | | | To replace the texinfo sources previously used to generate NOTICE. When compiled to HTML, compares well against the original NOTICE; use notice.rst in mitK5license.rst instead of using a literal include of the old NOTICE file. ticket: 7407
* Remove texinfo implementors guideBen Kaduk2012-10-152-1256/+0
| | | | | | | | | It is sufficiently old and unloved that nothing in it should be taken as truth without independent verification. Content of this nature should live on k5wiki.kerberos.org in the future. ticket: 7408
* Remove unused texinfo sourcesBen Kaduk2012-10-152-1775/+0
| | | | | | | Now that the users guide make rules are removed, some of the texinfo sources are not referenced from anywhere and can be safely removed. ticket: 7408
* Remove make glue for texinfo users guideBen Kaduk2012-10-151-35/+1
| | | | | | Towards removing the texinfo docs entirely. ticket: 7408
* Disconnect the texinfo users guide from the buildBen Kaduk2012-10-151-1/+1
| | | | | | | | | | | | | | | | | | Its content has been migrated to or superseded by the krb_users reST documentation. The texinfo document attempted to have a general introduction to Kerberos, but it is not quite suitable for the target audience of the user's guide and will be rewritten. A few portions of the texinfo document are simply no longer relevant and do not need to be migrated. In particular: The krb5-appl utilities are out of scope for this document, as they have been moved to a separate repository. Coverage of ksu may be brought back at a later time, though. The Kerberos Glossary will be expanded and handled separately. ticket: 7408
* Add a -C flag to klist to also show config entriesNalin Dahyabhai2012-10-151-0/+6
|
* Add responder support to preauth_otpNathaniel McCallum2012-10-151-0/+3
|
* Remove unused texinfo sourcesBen Kaduk2012-10-1210-6233/+0
| | | | | | | | Now that the admin guide make rules are removed, quite a few of the texinfo sources are not referenced from anywhere and can be safely removed. ticket: 7408
* Remove make glue for texinfo admin guideBen Kaduk2012-10-121-30/+1
| | | | | | Towards removing the texinfo docs entirely. ticket: 7408
* Disconnect the texinfo admin guide from the buildBen Kaduk2012-10-121-1/+1
| | | | | | | | | | | | | | | | | Its content has been migrated to or superseded by the reST documentation, essentially entirely in krb_admins. A few portions of the texinfo document are simply no longer relevant and do not need to be migrated. In particular: Information about reporting bugs lives on k5wiki.kerberos.org. General Kerberos concepts/introduction will be elsewhere in the tree. We do not need to document the time zones accepted by kadmin. We do not need a table of the various error codes and strings in our formal documentation. A complete description of the layout of our source tree is not useful or relevant to most Kerberos administrators. ticket: 7408
* Improve the ktadd and ktremove synopsesBen Kaduk2012-10-111-3/+4
| | | | | | | Mention the options on the synopsis line, and do not imply that the principal argument(s) for ktadd are optional. reST line blocks are needed to keep the two forms of ktadd on separate lines.
* Fix ordered list styleBen Kaduk2012-10-111-0/+22
| | | | | | | Sphynx outputs class information that corresponds to its generated basic.css, which we do not include. This results in all lists, even nested lists, using arabic numerals. Import the class properties into kerb.css for now.
* Fix copy/paste errors in dbadminBen Kaduk2012-10-111-4/+4
| | | | | | We should include the stashsrvpw content in that section, not the list content. Likewise, the list_policy content instead of the destroy_policy content.
* Update kdb5_util example outputBen Kaduk2012-10-111-2/+4
| | | | | | This text has not caught up with changes to the utility itself. As a side effect, our output text box is narrower and does not have to scroll on as many browser windows.
* Wordsmith kdb5_util stash -fBen Kaduk2012-10-111-1/+2
| | | | | | | The keyfile worth overriding is the one in kdc.conf. Though using stash -f would override kdb5_util's -sf argument, there is no reason to pass both flags to the same invocation. In any case, the "at startup" language is not really correct.
* Remove pronoun referent ambiguityBen Kaduk2012-10-111-2/+2
| | | | The policy must be unused, not the delete_policy command.