On Fri, Feb 07, 2020 at 08:46:05PM -0700, Aaron Bieber wrote: > 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? >
hi. i forget the logic, but i think the aim was to have a potential config somewhere helpful, without clogging the man pages. to that end, i'm not sure it'd make sense to effectively move the files back into the man pages. the best thing is probably for everyone to know there is such a thing as /etc/examples. i accept that's maybe unlikely. if we do reference these config files from the man pages, i guess that should be correctly done from a FILES section, since EXAMPLES is really showing how to use the tool, rather than how to configure it. it is a fine line though. i wouldn;t be against adding to FILES - it'd be very brief, make sense, and provide the reminder being asked for. jmc
