summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* Sphinx HTML: Collapse l4 in ToC in the sidebarZhanna Tsitkov2012-06-013-13/+35
| | | | | | | Also, - resize the width of the document vs sidebar; - decrease padding in the sidebar; - mark current l2 in ToC in the sidebar.
* Add a copy of the BSD <sys/queue.h> as k5-queue.hGreg Hudson2012-05-301-1/+2
| | | | | queue.h implements various types of linked lists as cpp macros, without needing any library support.
* Modified the Sphinx HTML page layoutZhanna Tsitkov2012-05-233-38/+106
| | | | | 1. The Feedback button is moved into the footer; 2. The default page/doc width are set to 960px;
* Make doc/coding-style point to wiki pageTom Yu2012-05-221-564/+3
| | | | | | | The old doc/coding-style file was out of date; replace its content with a pointer to the wiki page. ticket: 7147 (new)
* Remove mention of util/autoconfTom Yu2012-05-171-14/+8
| | | | | | | | | We no longer use our own customized version of autoconf, so remove mentions of the src/util/autoconf directory where that used to be. Reported by W. Trevor King. ticket: 7139 (new)
* Add API to interpret changepw result stringsGreg Hudson2012-05-091-0/+1
| | | | | | | | | | | | | Active Directory returns structured policy information in the nominally UTF-8 result string field of a password change reply. Add a new API krb5_chpw_message() to convert a result string into a displayable message, interpreting policy information if present. Patch from stefw@gnome.org with changes. ticket: 7128 git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25857 dc483132-0cff-0310-8789-dd5450dbe970
* Process param/defname node for "#define". Zhanna Tsitkov2012-05-053-4/+27
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25851 dc483132-0cff-0310-8789-dd5450dbe970
* For typedef documents in Sphinx do not add short description to the titlesZhanna Tsitkov2012-05-052-30/+14
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25850 dc483132-0cff-0310-8789-dd5450dbe970
* Add generalized definition of krb5_ui_4 and krb5_int32 to the documentation ↵Zhanna Tsitkov2012-05-053-1/+24
| | | | | | for better cross-referencing. Do not include internal structure krb5_cc_ops into Sphinx documentation git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25849 dc483132-0cff-0310-8789-dd5450dbe970
* The new version of Doxygen (1.7.6.1) produces different xml output around ↵Zhanna Tsitkov2012-05-031-1/+3
| | | | | | the <initializer> node. Adopt the script to the change. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25846 dc483132-0cff-0310-8789-dd5450dbe970
* Clarify profile pluggable interface documentationGreg Hudson2012-05-022-3/+11
| | | | | | | Explain how profile plugin modules integrate with libkrb5, since it's a bit different than usual. Also fix a broken note. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25843 dc483132-0cff-0310-8789-dd5450dbe970
* Draft initial credentials API documentationTom Yu2012-04-272-0/+60
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25835 dc483132-0cff-0310-8789-dd5450dbe970
* Rearrange navigation buttons in the HTML headerZhanna Tsitkov2012-04-261-3/+3
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25829 dc483132-0cff-0310-8789-dd5450dbe970
* Minor cleanup (mostly to remove the "Contents" section titles)Zhanna Tsitkov2012-04-255-22/+2
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25824 dc483132-0cff-0310-8789-dd5450dbe970
* Use "agogo" HTML theme (with some modifications) for the Sphinx ↵Zhanna Tsitkov2012-04-253-9/+112
| | | | | | documentation. Do not show the ReST source files git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25823 dc483132-0cff-0310-8789-dd5450dbe970
* Edit resources pageGreg Hudson2012-04-171-10/+11
| | | | | | | Improve description of kerberos and krbcore. Remove trailing whitespace throughout. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25813 dc483132-0cff-0310-8789-dd5450dbe970
* Rename mitresources.rst to resources.rstGreg Hudson2012-04-172-3/+3
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25812 dc483132-0cff-0310-8789-dd5450dbe970
* Translate @version Doxygen markup into rst formatZhanna Tsitkov2012-04-173-0/+33
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25811 dc483132-0cff-0310-8789-dd5450dbe970
* Added MIT resources documentZhanna Tsitkov2012-04-172-8/+49
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25809 dc483132-0cff-0310-8789-dd5450dbe970
* Add clock skew testsGreg Hudson2012-04-171-0/+3
| | | | | | | Add a KDC option (-T) to run with a time offset, and use that to test kdc_timesync behavior. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25807 dc483132-0cff-0310-8789-dd5450dbe970
* Correct kdc_timesync documentationGreg Hudson2012-04-171-7/+7
| | | | | | | kdc_timesync is read from the profile as an integer, not a boolean; go back to documenting it that way. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25806 dc483132-0cff-0310-8789-dd5450dbe970
* Edit RST docs on building RST docsGreg Hudson2012-03-311-5/+7
| | | | | | | Fix a couple of grammar errors noted by Ben Kaduk, and elaborate a little bit on why generated man pages are checked into the repository. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25798 dc483132-0cff-0310-8789-dd5450dbe970
* Add doc target with configured path substitutionsGreg Hudson2012-03-282-1/+24
| | | | | | | | | | Add a new target "substhtml" in src/doc to create HTML documentation with configured paths, suitable for installation by an OS package. The build target generates a file named paths.py containing the directory substitutions, copies it into the rst_composite directory, and instructs conf.py to use it with the "pathsubs" tag. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25795 dc483132-0cff-0310-8789-dd5450dbe970
* Use reference substitutions for paths in docsGreg Hudson2012-03-282-15/+17
| | | | | | | | | | | | For the default doc build (used for the web site and release tarball), substitute path variables with links to the paths table in mitK5defaults.rst, using symbolic names for the link text. The substitution of kdcdir for man pages is slightly altered as a side-effect of this commit. Regenerate the man pages to match. The rendered man pages are unchanged. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25794 dc483132-0cff-0310-8789-dd5450dbe970
* Edit defaults page in documentationGreg Hudson2012-03-282-93/+60
| | | | | | | | Eliminate unused values and OS-specific stuff. Reformat tables. Add a path substitution for sysconfdir to be used in the default config file path. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25793 dc483132-0cff-0310-8789-dd5450dbe970
* Move rstman build target to man directoryGreg Hudson2012-03-282-16/+6
| | | | | | | rstman makes more sense in man than in doc, so move it there. Remove the rstman target from the top-level doc Makefile to avoid confusion. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25792 dc483132-0cff-0310-8789-dd5450dbe970
* Automate RST HTML generation with doxygen infoGreg Hudson2012-03-287-120/+38
| | | | | | | | | In src/doc/Makefile.in, create an "rsthtml" target for generating release tarball/web site HTML docs in doc/rst_html. For now, eliminate support for the bridge to the Doxygen HTML output; just generate XML output with Doxygen and convert it to RST format. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25791 dc483132-0cff-0310-8789-dd5450dbe970
* Remove krb5-send-pr man pageGreg Hudson2012-03-243-210/+0
| | | | | | | | | | The license on the krb5-send-pr man page was incompatible with the rest of our documentation, and the content is questionably up to date (krb5-send-pr still exists, but we don't use GNATS any more, and free-form mail to krb5-bugs is equally acceptable at this point). Get rid of it for now. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25788 dc483132-0cff-0310-8789-dd5450dbe970
* Remove references to the "feedback" and the original source of the document ↵Zhanna Tsitkov2012-03-2315-91/+0
| | | | | | (such as Kerberos V5 Installation Guide etc) in the rst files git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25787 dc483132-0cff-0310-8789-dd5450dbe970
* Install path-substituted man pagesGreg Hudson2012-03-231-5/+17
| | | | | | | | | | | | | | Introduce src/doc/Makefile.in, which will eventually subsume doc/Makefile (but will still pull sources from doc). In the rstman target there, create man pages with symbolic path references (like @SBINDIR@). In man/Makefile.in, substitute the path references with the configured paths before installing. Man pages generated from RST source are now checked into the source tree under the name filename.man. This lets us use a single implicit .man.sub rule for the path substitutions. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25786 dc483132-0cff-0310-8789-dd5450dbe970
* 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
generated by cgit (git 2.34.1) at 2025-09-26 09:37:53 +0000