summaryrefslogtreecommitdiffstats
path: root/doc/rst_source/krb_users
Commit message (Collapse)AuthorAgeFilesLines
* Massive reST content renameBen Kaduk2012-10-1515-1600/+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
* Add a -C flag to klist to also show config entriesNalin Dahyabhai2012-10-151-0/+6
|
* Use '---' for em dashes in rst sourceBen Kaduk2012-08-061-2/+2
| | | | | | | | | Our sphinx configuration uses SmartyPants, which produces smart quotes and dashes in HTML output, using '--' for en dash and '---' for em dash. (This is also the LaTeX convention.) These points in the text are meant to be em dashes, so format them as such. Also standardize on no spaces around the dash per Chicago Manual of Style (and others).
* Remove "Synopsis" from .k5login .k5identity docsZhanna Tsitkov2012-08-032-10/+0
|
* Support changing the built-in ccache/keytab namesGreg Hudson2012-07-245-15/+10
| | | | | | | | | | | | | | * Add DEFCCNAME, DEFKTNAME, and DEFCKTNAME configure variables to change the built-in ccache and keytab names. * Add krb5-config options to display the built-in ccache and keytab names. * In the default build, use krb5-config to discover the system's built-in ccache and keytab names and use them (if not overridden). This can be controlled with the --with-krb5-config=PATH or --without-krb5-config configure options. * Make the built-in ccache name subject to parameter expansion. ticket: 7221 (new)
* Document references to date-time formatsZhanna Tsitkov2012-07-162-45/+14
|
* Add kinit/klist -i options to use client keytabGreg Hudson2012-07-162-6/+12
| | | | | | | | | In combination with -k, -i will cause kinit or klist to use the default client keytab instead of the default acceptor keytab. This gives an easy way to figure out what default client keytab name is in use and to get credentials using it. ticket: 7216 (new)
* Standardize on commas after "e.g.", "i.e."Ben Kaduk2012-07-121-5/+5
| | | | It seems to be "more correct".
* Sphinx html: reorder admin/user commands indexZhanna Tsitkov2012-07-111-3/+3
|
* Revert "Document absolute times for 'kinit -s'"Ben Kaduk2012-07-071-5/+1
| | | | | | | | This reverts commit 20f85a81151f69689e3c060e89852687eb6c5a3c. The ability of 'kinit -s' to accept an absolute time is intentionally undocumented and remains only for backwards compatibility. Leave a comment in the source to this effect, for future generations.
* Document absolute times for 'kinit -s'Ben Kaduk2012-07-061-1/+5
| | | | | | | | | | | kinit's -s argument takes a parameter, which is first interpreted as a time interval ("deltat"), in the same format used for the -l and -r arguments. However, if that fails, the time argument is interpreted as an absolute time, in one of twelve different possible formats, some of which are subject to localization via strptime(). Explicitly listing all twelve possible interpretations is overkill, but give the user a hint that absolute times are possible at all.
* Fix spelling of "start_time" in previousTom Yu2012-06-141-1/+1
|
* Document allowed time formats for kinit and ksuZhanna Tsitkov2012-06-142-13/+37
|
* Minor cleanup (mostly to remove the "Contents" section titles)Zhanna Tsitkov2012-04-251-3/+0
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25824 dc483132-0cff-0310-8789-dd5450dbe970
* Remove krb5-send-pr man pageGreg Hudson2012-03-242-209/+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-234-23/+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
* Use substitutions in RST docsGreg Hudson2012-03-222-2/+2
| | | | | | | 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
* Miscellaneous RST documentation editsGreg Hudson2012-03-164-30/+18
| | | | | | | 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
* 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
* Miscellaneous corrections to RST docsGreg Hudson2012-03-151-19/+20
| | | | | | | | | 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 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
* 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
* Remove "Feedback" paragraphs from the rst files.Zhanna Tsitkov2012-03-0819-133/+0
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25750 dc483132-0cff-0310-8789-dd5450dbe970
* Make sure thatZhanna Tsitkov2012-03-055-4/+12
| | | | | | | 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
* Fix the problem when the text of the examples and alike's was not properly ↵Zhanna Tsitkov2012-03-036-12/+24
| | | | | | indented in the man pages. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25727 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
* Clean up labels in RST docsGreg Hudson2012-02-276-9/+9
| | | | | | | 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-2718-71/+88
| | | | | | | 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
* Format pass over RST documentationGreg Hudson2012-02-2630-1347/+1700
| | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* Add shadow manpages for k5login.5 and k5identity.5Tom Yu2012-01-132-4/+12
| | | | | | | | | | | | 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-132-16/+16
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25652 dc483132-0cff-0310-8789-dd5450dbe970
* Added k5identity doc in RST format. Zhanna Tsitkov2012-01-123-16/+83
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25648 dc483132-0cff-0310-8789-dd5450dbe970
* Added documentation for sserver, sclient and krb5-send-pr in RST formatZhanna Tsitkov2012-01-093-0/+213
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25632 dc483132-0cff-0310-8789-dd5450dbe970
* Updated env variable sections, formating and other correctionsZhanna Tsitkov2011-12-223-13/+25
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25602 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
* Fix documentation typosGreg Hudson2011-11-071-1/+1
| | | | | | | 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
* Added documentation on how to build Kerberos. Mainly from the Installation ↵Zhanna Tsitkov2011-10-201-0/+2
| | | | | | Guide with some corrections git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25393 dc483132-0cff-0310-8789-dd5450dbe970
* Documentation - Updated the API list with the new interfaces. Zhanna Tsitkov2011-09-261-20/+20
| | | | | | Added reference to the examples subdirectory in Doxygen configuration file. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25238 dc483132-0cff-0310-8789-dd5450dbe970
* Add ccache collection support to toolsGreg Hudson2011-09-055-6/+101
| | | | | | | | | | | | | | | | * "kdestroy -A" destroys all caches in collection. * "kinit princ" searches the collection for a matching cache and overwrites it, or creates a new cache in the collection, if the type of the default cache is collection-enabled. The chosen cache also becomes the primary cache for the collection. * "klist -l" lists (in summary form) the caches in the collection. * "klist -A" lists the content of all of the caches in the collection. * "kswitch -c cache" (new command) makes cache the primary cache. * "kswitch -p princ" makes the cache for princ the primary cache. ticket: 6956 git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25157 dc483132-0cff-0310-8789-dd5450dbe970
* Fix a klist example in the user guideGreg Hudson2011-09-011-1/+1
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25123 dc483132-0cff-0310-8789-dd5450dbe970
* Removed some text from the Database Administration section as it duplicated ↵Zhanna Tsitkov2011-08-172-1/+5
| | | | | | kadmin(1). Instead, used references to kadmin(1) sub-sections git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25103 dc483132-0cff-0310-8789-dd5450dbe970
* Added .k5login, k5srvutil, ktutil, kadmind manual documnets to Sphins doc treeZhanna Tsitkov2011-08-052-0/+39
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25073 dc483132-0cff-0310-8789-dd5450dbe970
* Added kdb5_util man page to the Sphinx doc treeZhanna Tsitkov2011-08-051-0/+1
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25072 dc483132-0cff-0310-8789-dd5450dbe970
* Added ksu and kvno man pages documentation to Sphinx doc treeZhanna Tsitkov2011-08-014-1/+354
| | | | git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25066 dc483132-0cff-0310-8789-dd5450dbe970
* Added kpasswd, klist and kdestroy to Sphinx docs. Updated Sphinx ↵Zhanna Tsitkov2011-07-293-0/+218
| | | | | | configuration to build man pages for them git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25063 dc483132-0cff-0310-8789-dd5450dbe970
* Start building man pages from Sphinx documentation.Zhanna Tsitkov2011-07-293-0/+202
| | | | | | Added kinit document to Sphinx docs. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25062 dc483132-0cff-0310-8789-dd5450dbe970
* Initial commit of the Sphinx documentation source.Zhanna Tsitkov2011-06-2318-0/+736
One can build Sphinx documentation set in the html format by calling: sphinx-build sourcedir builddir For example: sphinx-build ./rst_source /tmp/build Note: This commit does not include the "Complete Reference - API and datatypes". This results into partial disabling of the function cross-referencing enhancement in the generated documentation. git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@24981 dc483132-0cff-0310-8789-dd5450dbe970
generated by cgit (git 2.34.1) at 2026-01-10 05:31:28 +0000