summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* Edit RST admin guide for clarity and accuracyGreg Hudson2012-03-1212-367/+174
| | | | | | | | | | | | | | | | | | Some more notable changes include: * plugin development is a top-level guide, so remove the advanced topic page in the admin guide. * Remove krb5-appl references in firewall configuration section. * Remove dns.rst since it was only referenced from a man page (which doesn't work) and just contained a pair of links, one of which was to the immediately preceding section. * Don't document TXT record support as if it were supported in the default build. It can be documented in an appendix. * A couple of troubleshooting segments gave very specifically-applicable advice based on general error messages, or described problems which were fixed several releases ago. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25762 dc483132-0cff-0310-8789-dd5450dbe970
* Fix the ref stringZhanna Tsitkov2012-03-091-1/+1
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25761 dc483132-0cff-0310-8789-dd5450dbe970
* Add pluggable interface RST documentationGreg Hudson2012-03-0811-0/+468
| | | | | | | | | | | | Create a new top-level section for plugin module developers. Document the general conventions for pluggable interfaces and an overview of each existing interface (except for GSSAPI mechanisms). Since we're not currently generating doxygen markup for plugin interface headers, refer to header files for detail-level documentation for now. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25759 dc483132-0cff-0310-8789-dd5450dbe970
* Document conventions used in RST sourceGreg Hudson2012-03-081-0/+46
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25758 dc483132-0cff-0310-8789-dd5450dbe970
* Do not generate "Feedback" sections in rst files for API documentationZhanna Tsitkov2012-03-083-28/+0
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25751 dc483132-0cff-0310-8789-dd5450dbe970
* Remove "Feedback" paragraphs from the rst files.Zhanna Tsitkov2012-03-0845-313/+5
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25750 dc483132-0cff-0310-8789-dd5450dbe970
* Extended Sphinx layout.html with a "feedback" referenceZhanna Tsitkov2012-03-081-0/+8
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25749 dc483132-0cff-0310-8789-dd5450dbe970
* Document KDC settings in kdc.conf manualGreg Hudson2012-03-072-188/+180
| | | | | | | | | Move the documentation for the [logging], [dbdefaults], and [dbmodules] sections and the database_module tag in kdc.conf rather than krb5.conf, now that (as of r18009, aka #3761, which went into krb5 1.5) KDC settings can be placed in either file. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25737 dc483132-0cff-0310-8789-dd5450dbe970
* Edit admin config file docs for clarityGreg Hudson2012-03-073-469/+356
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25736 dc483132-0cff-0310-8789-dd5450dbe970
* Make sure thatZhanna Tsitkov2012-03-0512-22/+43
| | | | | | | 1. a new-line " ::" is preceded by not more then one line of text; 2. a new line does not start with a whitespace(s) and a dot git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25734 dc483132-0cff-0310-8789-dd5450dbe970
* Consolidate application server docs into one fileGreg Hudson2012-03-057-243/+215
| | | | | | | Combine the contents of the krb_admins/appl_server directory into one file appl_server.rst. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25733 dc483132-0cff-0310-8789-dd5450dbe970
* Consolidate DB admin docs into one fileGreg Hudson2012-03-0530-1034/+894
| | | | | | | Combine the contents of the krb_admins/database directory into one file database.rst. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25732 dc483132-0cff-0310-8789-dd5450dbe970
* Remove eDirectory references in RST docsGreg Hudson2012-03-057-460/+0
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25731 dc483132-0cff-0310-8789-dd5450dbe970
* Remove admin_keytab references in code and docsGreg Hudson2012-03-044-27/+1
| | | | | | | | | The admin keytab hasn't been needed or used by kadmind since 1.4 (except possibly by legacy admin daemons which we no longer ship). Eliminate remaining references to it in code, test cases, and documentation. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25729 dc483132-0cff-0310-8789-dd5450dbe970
* Consolidate realm config docs into one fileGreg Hudson2012-03-039-297/+241
| | | | | | | Move the contents of the realm_config directory into one file realm_config.rst. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25728 dc483132-0cff-0310-8789-dd5450dbe970
* Fix the problem when the text of the examples and alike's was not properly ↵Zhanna Tsitkov2012-03-0316-83/+164
| | | | | | indented in the man pages. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25727 dc483132-0cff-0310-8789-dd5450dbe970
* Fix the reference to the non-existing labelZhanna Tsitkov2012-03-021-0/+1
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25726 dc483132-0cff-0310-8789-dd5450dbe970
* Consolidate RST install docs into larger filesGreg Hudson2012-03-0216-755/+670
| | | | | | | | Create two larger files (install_kdc.rst and install_clients.rst) and remove the install_kdc and install_clients directories. No significant changes to content. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25724 dc483132-0cff-0310-8789-dd5450dbe970
* Add GSSAPI acceptor names documentationGreg Hudson2012-02-292-0/+76
| | | | | | | | | In the application developer documentation, create a little bit of framing for documentation about krb5 GSS mechanism behavior and extensions, and create an initial section about how host-based service names affect keytab principal selection. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25722 dc483132-0cff-0310-8789-dd5450dbe970
* Remove unused RST filesZhanna Tsitkov2012-02-287-230/+0
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25721 dc483132-0cff-0310-8789-dd5450dbe970
* Correct some referencesZhanna Tsitkov2012-02-282-4/+1
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25720 dc483132-0cff-0310-8789-dd5450dbe970
* Fix the labelZhanna Tsitkov2012-02-281-1/+1
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25718 dc483132-0cff-0310-8789-dd5450dbe970
* Edit RST install guide for clarity and accuracyGreg Hudson2012-02-2710-296/+191
| | | | | | | | | | | | | | | Notable changes include: * In the example config files, configure logging in kdc.conf rather than krb5.conf. * It is no longer necessary to create a dummy database on slaves before propagating the master DB with kprop; remove that step from the instructions. * The admin keytab file is no longer required or used. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25717 dc483132-0cff-0310-8789-dd5450dbe970
* Clean up labels in RST docsGreg Hudson2012-02-2740-95/+90
| | | | | | | In various labels, correct typos, remove the redundant "_label" suffix, and avoid overabbreviating. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25715 dc483132-0cff-0310-8789-dd5450dbe970
* Improve man page references in RST documentationGreg Hudson2012-02-2767-329/+356
| | | | | | | Give each command and config file a reference label, and change many uses of command names and config file names to be references. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25714 dc483132-0cff-0310-8789-dd5450dbe970
* Updated versions and feature list; fixed some typosZhanna Tsitkov2012-02-261-5/+8
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25713 dc483132-0cff-0310-8789-dd5450dbe970
* Format pass over RST documentationGreg Hudson2012-02-26129-6924/+8443
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Without substantially changing the content, reformat RST documentation sources, normalizing: * Whitespace: four-space indentation where indentation is arbitrary; no trailing whitespace or tabs. Two spaces after sentence periods. * 70-column fill where lines can be wrapped (outside tables, mostly) * Section header underlines: = for page titles, - for sections, ~ and then # for subsections. Underlines exactly as long as titles. No trailing punctuation in titles. * Bullet lists: * for top-level bullets, - for sub-bullets. No indentation of the list bullets relative to the surrounding content. * Inline markup: italics for words representing variable text, boldface for config keywords and command option names, monospaced text for examples, pathnames. No adornment for command names and filenames. * Man page subcommands: subsection header for the subcommand, indented command synposis, then non-indented description and option list. * Man page command synopses: newline in source before each option. All parts of synopsis at same indentation level. (Ideally we'd want a hanging indent to the length of the command name, but RST doesn't seem to support that.) * Feedback links: in a separate section at the end. (This will need to be revisited as it affects some multi-level tables of contents.) git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25712 dc483132-0cff-0310-8789-dd5450dbe970
* Document the following kadmin commands and/or the related privieleges:Zhanna Tsitkov2012-02-221-16/+108
| | | | | | | | | | | | | | - set_string, get_strings, del_string - rename_principal - get_privs - purgekeys - lock/unlock - list_requests - quit Also, some minor formatting fixes. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25710 dc483132-0cff-0310-8789-dd5450dbe970
* Source code license to 2-clause BSDTom Yu2012-02-061-18/+37
| | | | | | | Change overall souce code license to 2-clause BSD. Also change example license in src/prototype to 2-clause BSD. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25671 dc483132-0cff-0310-8789-dd5450dbe970
* Add shadow manpages for k5login.5 and k5identity.5Tom Yu2012-01-134-11/+18
| | | | | | | | | | | | Add shadow manpages dot.k5login and dot.k5identity for k5login.5 and k5identity.5. Stop generating .k5login.5 and .k5identity.5 from sphinx (these will be taken care of by make install in src/man). Add generated k5identity.5. Add SYNOPSIS sections to k5login.5 and k5identity.5 to make it more clear that the filenames start with a dot. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25653 dc483132-0cff-0310-8789-dd5450dbe970
* Reverted reference to klogind. Minor reformatingZhanna Tsitkov2012-01-133-53/+61
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25652 dc483132-0cff-0310-8789-dd5450dbe970
* Updated domain_realm section of krb5.conf. Reformated filesZhanna Tsitkov2012-01-122-238/+747
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25649 dc483132-0cff-0310-8789-dd5450dbe970
* Added k5identity doc in RST format. Zhanna Tsitkov2012-01-125-20/+87
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25648 dc483132-0cff-0310-8789-dd5450dbe970
* documentation license to CC-BY-SA 3.0 UnportedTom Yu2012-01-102-37/+17
| | | | | | | | | | | Update documentation license to Creative Commons Attribution-ShareAlike 3.0 Unported. ticket: 7067 target_version: 1.10 tags: pullup git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25633 dc483132-0cff-0310-8789-dd5450dbe970
* Added documentation for sserver, sclient and krb5-send-pr in RST formatZhanna Tsitkov2012-01-096-0/+311
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25632 dc483132-0cff-0310-8789-dd5450dbe970
* delete duplicate NOTICE fileTom Yu2012-01-092-1141/+1
| | | | | | | | | | Delete the duplicate NOTICE file, as it is checked into the tree and relative include paths work for sphinx. ticket: 7065 status: open git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25631 dc483132-0cff-0310-8789-dd5450dbe970
* install sphinx-generated manpagesTom Yu2012-01-092-2/+15
| | | | | | | | | | | | | | | | | Install sphinx-generated manpages. Original nroff manpages remain for reference until proofreading is complete. Modify doc/rst_source/conf.py to better deal with shadow manpages -- sphinx will now build k5login.5 instead of .k5login.5, and kadmin.1 instead of both kadmin.1 and kadmin.local.8. Proofreaders should ensure that the original nroff manpages (and associated Makefile rules) are deleted once their reST format equivalents have been proofread. ticket: 7064 status: open git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25625 dc483132-0cff-0310-8789-dd5450dbe970
* Updated env variable sections, formating and other correctionsZhanna Tsitkov2011-12-2210-70/+164
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25602 dc483132-0cff-0310-8789-dd5450dbe970
* Remove MITKC logo from the treeZhanna Tsitkov2011-12-202-1/+1
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25599 dc483132-0cff-0310-8789-dd5450dbe970
* Correct typos and formatingZhanna Tsitkov2011-12-192-43/+46
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25594 dc483132-0cff-0310-8789-dd5450dbe970
* FormatingZhanna Tsitkov2011-12-151-21/+51
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25589 dc483132-0cff-0310-8789-dd5450dbe970
* Remove reference to krb5_anadd. Correct the name of HAVE_GETUSERSHELL flagZhanna Tsitkov2011-12-071-140/+164
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25533 dc483132-0cff-0310-8789-dd5450dbe970
* Added Test Coverage topicZhanna Tsitkov2011-11-302-0/+34
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25495 dc483132-0cff-0310-8789-dd5450dbe970
* Formating fixes and update per rev#25480Zhanna Tsitkov2011-11-212-84/+78
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25481 dc483132-0cff-0310-8789-dd5450dbe970
* Document --with-system-verto in rst docsGreg Hudson2011-11-181-0/+18
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25478 dc483132-0cff-0310-8789-dd5450dbe970
* Adjust "make check" constraints in rst docsGreg Hudson2011-11-151-3/+8
| | | | | | | | Recopy the text from the texinfo build docs into the rst version, describing --disable-rpath and avoiding an erroneous reference to make fake-install. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25476 dc483132-0cff-0310-8789-dd5450dbe970
* Updated text for the KRB5_TRACE env variable.Zhanna Tsitkov2011-11-093-9/+11
| | | | | | | Updated Sphinx index with the new API functions and changed macros names. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25465 dc483132-0cff-0310-8789-dd5450dbe970
* Added Environment Variables document.Zhanna Tsitkov2011-11-085-17/+86
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25457 dc483132-0cff-0310-8789-dd5450dbe970
* Fix documentation typosGreg Hudson2011-11-077-17/+17
| | | | | | | Fix the typos from r25290 which were also present in the RST documentation. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25446 dc483132-0cff-0310-8789-dd5450dbe970
* Improve verto and libev documentationGreg Hudson2011-11-051-0/+27
| | | | | | | | | | | | | NOTICE was missing the copyright statement for verto (it's not quite the same as other Red Hat licenses). util/verto had no README file, and neither the verto nor k5ev README contained pointers to the upstream project pages. ticket: 7002 target_version: 1.10 tags: pullup git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25443 dc483132-0cff-0310-8789-dd5450dbe970
generated by cgit (git 2.34.1) at 2025-09-26 20:51:52 +0000