summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* Miscellaneous small edits to RST docsGreg Hudson2012-03-223-13/+11
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25785 dc483132-0cff-0310-8789-dd5450dbe970
* Use substitutions in RST docsGreg Hudson2012-03-2216-92/+91
| | | | | | | Create an rst_epilog variable defining substitutions for pathnames and default enctypes, and use them in the RST source files. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25784 dc483132-0cff-0310-8789-dd5450dbe970
* Describe trace logging in troubleshooting docsGreg Hudson2012-03-211-0/+27
| | | | | | | Add a section to the troubleshooting page in the RST documentation describing how to use trace logging and giving sample output. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25782 dc483132-0cff-0310-8789-dd5450dbe970
* Move supported enc/salt type docs to kdc.conf(5)Greg Hudson2012-03-207-87/+86
| | | | | | | | Remove enc_types.rst and move its contents into kdc.conf(5). Adjust references so that man page readers can find the section in the kdc.conf man page. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25780 dc483132-0cff-0310-8789-dd5450dbe970
* Do not insert a timestamp into manpages and Sphinx main pageZhanna Tsitkov2012-03-192-2/+1
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25779 dc483132-0cff-0310-8789-dd5450dbe970
* Correct the location of k5identity and k5login in the man_page section of ↵Zhanna Tsitkov2012-03-191-2/+2
| | | | | | the Sphinx config file git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25778 dc483132-0cff-0310-8789-dd5450dbe970
* Miscellaneous RST documentation editsGreg Hudson2012-03-1615-83/+59
| | | | | | | Make small changes to various RST documentation pages to improve clarity or remove outdated statements. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25776 dc483132-0cff-0310-8789-dd5450dbe970
* Move privileges section in database admin docsGreg Hudson2012-03-161-97/+97
| | | | | | | | | | | | | | The "Privileges" section in the RST database administration documentation was tucked away in the middle of a section on principal operations. Move it out and put it between policy operations and kdb5_util operations, without changing its content. (We may want to replace this whole section with a reference to the appropriate part of the kadmind man page, but that requires a bit of reconciliation since the kadmind man page doesn't document restrictions yet.) git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25775 dc483132-0cff-0310-8789-dd5450dbe970
* Reorder top-level RST doc sectionsGreg Hudson2012-03-161-3/+3
| | | | | | | Order the top-level documentation according to the expertise level of the intended audience. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25774 dc483132-0cff-0310-8789-dd5450dbe970
* Document the ccselect interface in krb5.confGreg Hudson2012-03-161-2/+19
| | | | | | | r25158 (#6957) omitted krb5.conf documentation for the ccselect interface. Add it now. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25773 dc483132-0cff-0310-8789-dd5450dbe970
* Revise RST install guide client configurationGreg Hudson2012-03-161-88/+47
| | | | | | | | | Stop recommending login.krb5. Remove outdated OSX instructions. Don't suggest modifying /etc/services as we don't rely on it any more (and it's generally already done by the OS these days). Add new guidance for krb5.conf settings. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25772 dc483132-0cff-0310-8789-dd5450dbe970
* Edit RST user man pages for clarity and accuracyGreg Hudson2012-03-166-92/+74
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25771 dc483132-0cff-0310-8789-dd5450dbe970
* Edit RST admin man pages for clarity and accuracyGreg Hudson2012-03-1512-919/+555
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25770 dc483132-0cff-0310-8789-dd5450dbe970
* Miscellaneous corrections to RST docsGreg Hudson2012-03-152-20/+21
| | | | | | | | | Fix various small errors pointed out by Ben Kaduk (and a couple of minor misstatements in text adjacent to them). ticket: 7106 git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25769 dc483132-0cff-0310-8789-dd5450dbe970
* Add plugin configuration documentationGreg Hudson2012-03-143-2/+107
| | | | | | | | In the RST admin guide, add a page for host configuration, and include a subsection on registering, enabling, and disabling plugin modules. For now, do not cover the private KDB and authdata plugin interfaces. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25768 dc483132-0cff-0310-8789-dd5450dbe970
* Add config file section in RST user guideGreg Hudson2012-03-145-4/+13
| | | | | | | | Move the .k5identity and .k5login man pages to a separate section from user commands. Also, kadmin.local and k5srvutil are not user-oriented commands, so don't link to them in the user_commands index. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25767 dc483132-0cff-0310-8789-dd5450dbe970
* Remove user_appl section in RST docsGreg Hudson2012-03-149-402/+0
| | | | | | | | | | The user_appl directory contained documentation for krb5_appl programs which have largely been subsumed by ssh, for ksu (essentially duplicating the ksu man page), and for ssh (a stub). Get rid of the whole thing for now; we can add an ssh section back into the user guide when we have more written about it. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25766 dc483132-0cff-0310-8789-dd5450dbe970
* Bring ticket management documentation up to dateGreg Hudson2012-03-141-24/+31
| | | | | | | Refer to ssh instead of telnet; refer to login system integration instead of the Kerberos login program. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25765 dc483132-0cff-0310-8789-dd5450dbe970
* Created a new basic Kerberos concepts section and moved stash_file_def thereZhanna Tsitkov2012-03-143-0/+11
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25764 dc483132-0cff-0310-8789-dd5450dbe970
* Consolidate password and ticket management docsGreg Hudson2012-03-1412-427/+426
| | | | | | | | In the RST documentation, combine the pwd_mgmt and tkt_mgmt subdirectories of krb_users into single files, without changing the content. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25763 dc483132-0cff-0310-8789-dd5450dbe970
* 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
generated by cgit (git 2.34.1) at 2025-09-27 01:22:51 +0000