Bug 33645

Summary: k5list(1) contains many incorrect "klist" entries.
Product: Documentation Reporter: rdm <rdm>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
kerberos5.patch
none
crypto_heimdal.patch none

Description rdm 2002-01-07 11:40:00 UTC
        At many locations in the k5list(1) man page, the program
        name is given as "klist".  There is, however, a man page
        for klist(1), per se.  Also, /usr/bin/{k,k5}list are two
        separate files.

Fix: 

Edit "klist" to "k5list" throughout the k5list man page.
        Might also want to put in a SEE ALSO link to klist(1).
How-To-Repeat: 
        % man k5list
Comment 1 darklogik 2002-01-10 15:43:51 UTC
Is this contributed software?  Should it be reported to the maintainer, 
or perhaps where the software came from?  This is only being pointed out 
because I do not have k5list(1) or klist(1) on my 4.4-RELEASE nor 
5.0-CURRENT system...  Comments?


-- 
Tom (Darklogik) Rhodes
www.Pittgoth.com Gothic Liberation Front
www.FreeBSD.org  The Power To Serve
Comment 2 ru freebsd_committer freebsd_triage 2002-01-16 15:04:25 UTC
Responsible Changed
From-To: freebsd-doc->assar

Assar, could you please fix this and commit the fix on the vendor 
and RELENG_4 branches (if re@ approves).
Comment 3 ru freebsd_committer freebsd_triage 2002-01-24 12:00:40 UTC
On Wed, Jan 23, 2002 at 08:55:16PM +0100, assar@FreeBSD.org wrote:
> Ruslan Ermilov <ru@FreeBSD.org> writes:
> > Besides some bugs in Makefiles (please test them with "make all-man"),
> > may I suggest that you use MANFILTER to tweak the contents of manpages
> > rather than patching them directly on the HEAD branch and taking them
> > off the vendor branch?
> 
> That's a better idea.  This patch (which passes "make all-man") does
> that.  Comments?
> 
kadmin didn't pass the "make all-man" for me, CLEANFILES still not
fixed, style bugs (should be space after a ":" on dependency lines).
Besides that, there are some undesirable changes caused by this
MANFILTER:

: --- ./libexec/hpropd/hpropd.8.filt.old	Thu Jan 24 12:34:13 2002
: +++ ./libexec/hpropd/hpropd.8.filt	Thu Jan 24 12:34:58 2002
: @@ -53,7 +53,7 @@
:  Principals are always allowed to change their own password and list
:  their own principals.  Apart from that, doing any operation requires
:  permission explicitly added in the ACL file
: -.Pa /var/heimdal/kadmind.acl .
: +.Pa /var/heimdal/k5admind.acl .
:  The format of this file is:
:  .Bd -ragged
:  .Va principal
: @@ -122,16 +122,16 @@
:  .El
:  .\".Sh ENVIRONMENT
:  .Sh FILES
: -.Pa /var/heimdal/kadmind.acl
: +.Pa /var/heimdal/k5admind.acl
:  .Sh EXAMPLES
: --- ./lib/libkrb5/krb5.conf.5.filt.old	Thu Jan 24 12:34:12 2002
: +++ ./lib/libkrb5/krb5.conf.5.filt	Thu Jan 24 12:34:57 2002
: @@ -188,9 +188,9 @@
:  .It Li admin_server = Va host[:port]
:  Specifies the admin server for this realm, where all the modifications
:  to the database are perfomed.
: -.It Li kpasswd_server = Va host[:port]
: +.It Li k5passwd_server = Va host[:port]
:  Points to the server where all the password changes are perfomed.
: -If there is no such entry, the kpasswd port on the admin_server host
: +If there is no such entry, the k5passwd port on the admin_server host
:  will be tried.
:  .It Li v4_instance_convert
:  .It Li v4_name_convert
: @@ -270,10 +270,10 @@
:  .It logging = Va Logging
:  What type of logging the kdc should use, see also [logging]/kdc.
:  .El
: -.It Li [kadmin]
: +.It Li [k5admin]
:  .Bl -tag -width "xxx" -offset indent
:  .It require-preauth = Va BOOL

The solution I have found working without ill effects was:

1.  Modify MANFILTER to only do substitutions for the .Dt, .Nm,
    and .Xr macros.

2.  Tweak relevant manpages that miss the necessary markup bits.

Attached are two patches, for kerberos5/ and for crypto/heimdal/
that implement this, and fix the bugs mentioned above.


Cheers,
-- 
Ruslan Ermilov		Oracle Developer/DBA,
ru@sunbay.com		Sunbay Software AG,
ru@FreeBSD.org		FreeBSD committer,
+380.652.512.251	Simferopol, Ukraine

http://www.FreeBSD.org	The Power To Serve
http://www.oracle.com	Enabling The Information Age
Comment 4 assar freebsd_committer freebsd_triage 2002-01-24 15:31:02 UTC
Ruslan Ermilov <ru@FreeBSD.org> writes:
> kadmin didn't pass the "make all-man" for me, CLEANFILES still not
> fixed, style bugs (should be space after a ":" on dependency lines).
> Besides that, there are some undesirable changes caused by this
> MANFILTER:

Ah, too large hammer.

> 1.  Modify MANFILTER to only do substitutions for the .Dt, .Nm,
>     and .Xr macros.
> 
> 2.  Tweak relevant manpages that miss the necessary markup bits.

Good.

> Attached are two patches, for kerberos5/ and for crypto/heimdal/
> that implement this, and fix the bugs mentioned above.

Ok, except the patches to krb5-config.1 and krb5.conf.5, in those
kadmin is not used as in the sense of the kadmin program and hence
should not be replaced.  I've applied the patches to the other
man-pages in the upstream CVS repository.  Do you want to commit these
and the makefile fixes to FreeBSD or should I?

/assar
Comment 5 ru freebsd_committer freebsd_triage 2002-01-24 16:32:15 UTC
On Thu, Jan 24, 2002 at 04:31:02PM +0100, assar@FreeBSD.org wrote:
> Ruslan Ermilov <ru@FreeBSD.org> writes:
> > kadmin didn't pass the "make all-man" for me, CLEANFILES still not
> > fixed, style bugs (should be space after a ":" on dependency lines).
> > Besides that, there are some undesirable changes caused by this
> > MANFILTER:
> 
> Ah, too large hammer.
> 
> > 1.  Modify MANFILTER to only do substitutions for the .Dt, .Nm,
> >     and .Xr macros.
> > 
> > 2.  Tweak relevant manpages that miss the necessary markup bits.
> 
> Good.
> 
> > Attached are two patches, for kerberos5/ and for crypto/heimdal/
> > that implement this, and fix the bugs mentioned above.
> 
> Ok, except the patches to krb5-config.1 and krb5.conf.5, in those
> kadmin is not used as in the sense of the kadmin program and hence
> should not be replaced.  I've applied the patches to the other
> man-pages in the upstream CVS repository.  Do you want to commit these
> and the makefile fixes to FreeBSD or should I?
> 
You please.  :-)


Cheers,
-- 
Ruslan Ermilov		Oracle Developer/DBA,
ru@sunbay.com		Sunbay Software AG,
ru@FreeBSD.org		FreeBSD committer,
+380.652.512.251	Simferopol, Ukraine

http://www.FreeBSD.org	The Power To Serve
http://www.oracle.com	Enabling The Information Age
Comment 6 Mark Linimon freebsd_committer freebsd_triage 2004-08-26 04:06:07 UTC
State Changed
From-To: open->feedback

Is this still a problem with modern versions of FreeBSD? 


Comment 7 Mark Linimon freebsd_committer freebsd_triage 2004-08-26 04:06:07 UTC
Responsible Changed
From-To: assar->freebsd-bugs

With bugmeister hat on, reassign from inactive committer.
Comment 8 Mark Linimon freebsd_committer freebsd_triage 2004-08-26 05:14:17 UTC
Responsible Changed
From-To: freebsd-bugs->freebsd-doc

I missed the fact that this is a docs PR.
Comment 9 ru freebsd_committer freebsd_triage 2004-08-26 07:25:33 UTC
On Thu, Aug 26, 2004 at 03:06:23AM +0000, Mark Linimon wrote:
> Synopsis: k5list(1) contains many incorrect "klist" entries.
> 
> State-Changed-From-To: open->feedback
> State-Changed-By: linimon
> State-Changed-When: Thu Aug 26 03:06:07 GMT 2004
> State-Changed-Why: 
> Is this still a problem with modern versions of FreeBSD?
> 
It's no longer a problem in HEAD and RELENG_5, since
KerberosIV deorbit.  It's still a problem in RELENG_4,
but it's unlikely that this will get fixed, so I
suggest just closing this PR.


Cheers,
-- 
Ruslan Ermilov
ru@FreeBSD.org
FreeBSD committer
Comment 10 Mark Linimon freebsd_committer freebsd_triage 2004-08-26 07:32:26 UTC
State Changed
From-To: feedback->closed

Ruslan reports that this is only a problem in 4.x.  Unless someone 
wants to backport the fix, he suggests simply closing the PR.