summaryrefslogtreecommitdiffstats
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
...
* 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.
* Move cross-realm info to the cross-realm sectionBen Kaduk2012-10-111-16/+10
| | | | | | | | It's really not appropriate for the "examples" subsection of "Adding, modifying and deleting principals". While here, update the enctype recommendation for cross-realm principals to something that does not include weak crypto.
* Normalize format of kadmin option descriptionsBen Kaduk2012-10-101-27/+28
| | | | | Start with a capital letter and end with a full stop, making the description a sentence (or at least close to one).
* Correct kadm5.acl synopsisBen Kaduk2012-10-101-1/+1
| | | | | | The target principal and restrictions arguments are not orthogonal; a target principal argument must be given in order for a restriction list to be supplied.
* Make the kadm5.acl example saneBen Kaduk2012-10-101-9/+10
| | | | | | | | | It is an eggregious security violation to give all admin principals admin rights and then give all null instances permission to change the password of the associated admin instance. While here, don't assume that admin and root are the only non-null instances, and correct the formatting of an entry with restrictions.
* kadm5.acl line order is importantBen Kaduk2012-10-101-2/+2
| | | | Make it a special note in the documentation to help it stand out.
* Wordsmith in kadm5_acl.rstBen Kaduk2012-10-101-2/+2
| | | | Grammar fixup and avoid jargon.
* Wordsmith SRV records for KDCsBen Kaduk2012-10-101-5/+6
| | | | | Tweak the wording a bit to be more clear and avoid using multiple words deriving from the stem "use" in close succession.
* Document TXT records for realm lookupBen Kaduk2012-10-101-1/+22
| | | | | | | | | Even though they are subject to vulnerabilities via DNS spoofing and we accordingly don't recommend their use, we do have the code to use them. Just as we document dns_lookup_realm in krb5.conf(5), document them here. ticket: 7407
* Remove unused texinfo sourcesBen Kaduk2012-10-103-2461/+1
| | | | | | | | Now that the install guide make rules are removed, nothing references build.texinfo or install.texinfo any more (other than the tgz target, which is updated accordingly). ticket: 7408
* Remove make glue for texinfo install guideBen Kaduk2012-10-101-30/+1
| | | | | | Towards removing the texinfo docs entirely. ticket: 7408
* Disconnect texinfo install guide from the buildBen Kaduk2012-10-101-1/+1
| | | | | | | | | | | | | | | | | Its content has been migrated to or superseded by the RST documentation, split amongst krb_build and various sections of krb_admins. A few portions of the texinfo document are simply no longer relevant and do not need to be migrated. In particular: It's 2012; we don't need to specify that we require a C89 compiler. It's 2012; it will be easy to get enough disk to build krb5. The KADM5 tests are part of 'make check' and don't need separate documentation. Shared library support is not limited to "a few operating systems". We do not need to document incompatibilities with ancient/dead OSes. kadmind4 and v5passwdd are no longer relevant. ticket: 7408
* Add section on updating from single-DESBen Kaduk2012-10-093-1/+132
| | | | | | | | | | | | | There are, unfortunately, still some single-DES deployments out there. Try to help them along by documenting a procedure for migrating to stronger crypto. The texinfo install guide had a section on "upgrading", but it was not really suitable for direct import into a RST document. For one, it gave a high profile to the on-disk incompatibilities in upgrades to 1.1 and 1.2. It also was driven at upgrading *to* triple-des (or RC4), which are something of a dead-end. This new text attempts to be more general and applicable to today's environment.
* Add a kdb5_util examples for old KDC upgradesBen Kaduk2012-10-091-0/+20
| | | | | | | | | | | | It's a slightly less-contrived use case of the utility than the other example, which reads more like a usage statement. Give a motivating sentence before each example, and note that this new example is not needed in the general upgrade case. The need to dump/load for upgrades prior to 1.2 was documented in the texinfo install guide, but not in any RST sources until now. ticket: 7407
* Document DejaGnu dependency and manual testsBen Kaduk2012-10-081-0/+11
| | | | | | | | | The Texinfo install guide had a separate subsection about the DejaGnu tests which did not get converted to the RST source. In the testing section, also link to the wiki page on manual testing. ticket: 7407
* Remove bug-report.texinfoBen Kaduk2012-10-082-11/+1
| | | | | | It is unused; send-pr.texinfo supercedes it at the moment anyway. ticket: 7408
* Add -R option to kproplog to force full resyncsNicolas Williams2012-10-052-0/+9
| | | | ticket: 7375
* Deprecate kpropd -S optionNicolas Williams2012-10-051-5/+5
| | | | ticket: 7376
* Correct docs re: kpropd usage w/ ipropNicolas Williams2012-10-052-7/+8
| | | | ticket: 7379
* Add -p, -F, -K options to kadmindNicolas Williams2012-10-051-0/+15
| | | | | | | | | | | | New options: -p path-to-kdb5_util -K path-to-kprop -F dump-file These are needed for testing without first having to install. ticket: 7372
* Improve kpropd behavior in iprop modeNicolas Williams2012-10-052-0/+7
| | | | | | | | | | | | | | | | | | | | | | - Make kpropd in iprop mode fork a child to listen for kprops from the master. The child writes progress and outcome reports to the parent for each kprop. This fixes a race between asking for a full resync and setting up a listener socket for it. - Add runonce (-t) for kpropd do_standalone() too. - Add a new iprop parameter: iprop_resync_timeout. kpropd will keep asking for incremental updates while waiting for a full resync to finish, and will re-request a full resync if kadmind continues to indicate that one is needed after this timeout passes since the previous full resync was requested. - Allow polling intervals less than 10 seconds. [ghudson@mit.edu: split out debug output changes; note polling interval change in commit message] ticket: 7373