On Fri, 07 Feb 2020 at 17:49:41 -0800, Kyle Isom wrote:
> I was looking through the dhclient.conf man page and missed that there was an 
> example config in /etc/examples, so  I added this to the man page. I'm also 
> happy to go through the rest of man pages for the examples and add them if 
> there's interest.
> 
> Cheers,
> Kyle
> 
> 
> Index: sbin/dhclient/dhclient.conf.5
> ===================================================================
> RCS file: /cvs/src/sbin/dhclient/dhclient.conf.5,v
> retrieving revision 1.49
> diff -u -p -u -p -r1.49 dhclient.conf.5
> --- sbin/dhclient/dhclient.conf.5     17 Dec 2019 14:21:54 -0000      1.49
> +++ sbin/dhclient/dhclient.conf.5     8 Feb 2020 00:22:38 -0000
> @@ -288,6 +288,11 @@ instead of the
>  .Ic sname
>  field of the DHCP offer when binding a lease.
>  .El
> +.Sh EXAMPLE
> +There is an example
> +.Pa dhclient.conf
> +in
> +.Pa /etc/examples/dhclient.conf .
>  .Sh SEE ALSO
>  .Xr dhclient.leases 5 ,
>  .Xr dhcp-options 5 ,
> 

IMO this is worth doing. acme-client.1 and httpd.conf.5 have reference to
/etc/examples, and I have run into a number of people that are unaware of the
existence of the examples.

Maybe something a bit more similar to what's in acme-client(1) which uses a
more standard EXAMPLES section:

.Sh EXAMPLES
Example configuration files for
.Nm
and
.Xr httpd 8
are provided in
.Pa /etc/examples/acme-client.conf

I talked with tj@ about this as well, he suggested another route would be to
add full examples in the lacking pages. IMO both approaches would probably be
beneficial but I think directing more attention to /etc/examples is a good
start.

Anyone else have any thoughts?

-- 
PGP: 0x1F81112D62A9ADCE / 3586 3350 BFEA C101 DB1A  4AF0 1F81 112D 62A9 ADCE

Reply via email to