Bug 238643 - missing man pages: unbound.conf(5), local-unbound-checkconf(8), nsd(8)
Summary: missing man pages: unbound.conf(5), local-unbound-checkconf(8), nsd(8)
Status: Closed Not A Bug
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: Cy Schubert
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2019-06-17 06:51 UTC by Ronald F. Guilmette
Modified: 2020-11-14 04:31 UTC (History)
5 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Ronald F. Guilmette 2019-06-17 06:51:54 UTC
Apparently, the local-unbound name server is now part of the base system.  (At least it is in the 12.0-RELEASE system that I've recently installed.)

The man page for local-unbound(8) exists and is properly accessible via "man 8 local-unbound" however that man page makes reference also to the following additional man pages, none of which seem to be present on a freshly installed 12.0-RELEASE system:

unbound.conf(5), local-unbound-checkconf(8), nsd(8)

My hope is that this will be rectified in some fashion.
Comment 1 Ronald F. Guilmette 2019-06-17 07:01:35 UTC
Apologies.  I made an error in this PR.  Actually, there *is* a man page present and properly avaiable for local-unbound-checkconf(8).

The other two man pages that I mentioned however are indeed missing from the base system, i.e. the ones for:

unbound.conf(5)
nsd(8)

Also and additionally, the contents of the file /var/unbound/unbound.conf on a freshly installed 12.0-RELEASE system cntain the following lines:

# This file was generated by local-unbound-setup.
# Modifications will be overwritten.

And indeed, there is a program installed on this system, presumably as part of the base system, called /usr/sbin/local-unbound-setup

Unfortunately, this program also has no man page.

I hope that this omission can be corrected also.
Comment 2 Ronald F. Guilmette 2019-06-17 07:15:33 UTC
Just to further clarify why I wanted to see man pages for these various unbound-related things, I wanted to configure local-unbound so that it would respond to DNS queries from my entire (RFC1918) local network.

Apparently, I am not alone in this regard:

https://forums.freebsd.org/threads/this-file-was-generated-by-local-unbound-setup.61102/

https://forums.freebsd.org/threads/unbound.60475/#post-347821

Other people have also found reasons to want or need to run local-unbound-setup, in particular:

https://revprez.github.io/posts/2017-09-09-local_unbound-on-freebsd-11.html

It is clear from all this that, at the very least, a man page for local-unbound-setup would be beneficial.
Comment 3 Cy Schubert freebsd_committer 2020-10-29 04:36:30 UTC
Let's go through each one, instance by instance.

unbound.conf: This is local-unbound.conf.5.

-r--r--r--  1 root  wheel    31K Oct 28 15:02 /usr/share/man/man5/local-unbound.conf.5.gz

local-unbound-checkconf.8: This file exists.
-r--r--r--  1 root  wheel   666B Oct 28 15:02 /usr/share/man/man8/local-unbound-checkconf.8.gz

nsd: nsd is not installed in base FreeBSD. The port must be used.
Comment 4 Cy Schubert freebsd_committer 2020-11-14 04:31:38 UTC
Use the local-unbound-* man pages.