For complicated configurations, the text could explain the reason the
example is valuable -- for instance

+.It Pa /etc/examples/bgpd.conf
Example configuration file demonstrating IBGP mesh, multiple transits,
RPKI filtering, and other best practices.


The same idea can carry to other files. I've already provided some
similar words for the httpd.conf example...

> So, here is a specific patch for bgpf.conf(5) and bgpd(8) such
> that we can agree on a general direction for one case where
> the example file is particularly important.
> 
> Once the direction is agreed, applying it to the relatively
> small number of other cases is likely not difficult.
> 
> OK?
>   Ingo
> 
> 
> Index: bgpd.8
> ===================================================================
> RCS file: /cvs/src/usr.sbin/bgpd/bgpd.8,v
> retrieving revision 1.62
> diff -u -p -r1.62 bgpd.8
> --- bgpd.8    10 Nov 2019 20:51:53 -0000      1.62
> +++ bgpd.8    8 Feb 2020 23:24:28 -0000
> @@ -205,11 +205,13 @@ Only check the configuration file for va
>  Produce more verbose output.
>  .El
>  .Sh FILES
> -.Bl -tag -width "/var/run/bgpd.sockXXX" -compact
> +.Bl -tag -width "/etc/examples/bgpd.conf" -compact
>  .It Pa /etc/bgpd.conf
>  default
>  .Nm
>  configuration file
> +.It Pa /etc/examples/bgpd.conf
> +example file, do not edit
>  .It Pa /var/run/bgpd.sock
>  default
>  .Nm
> Index: bgpd.conf.5
> ===================================================================
> RCS file: /cvs/src/usr.sbin/bgpd/bgpd.conf.5,v
> retrieving revision 1.199
> diff -u -p -r1.199 bgpd.conf.5
> --- bgpd.conf.5       25 Jan 2020 12:07:28 -0000      1.199
> +++ bgpd.conf.5       8 Feb 2020 23:24:28 -0000
> @@ -1883,10 +1883,12 @@ For prefixes with equally long paths, th
>  is selected.
>  .El
>  .Sh FILES
> -.Bl -tag -width "/etc/bgpd.conf" -compact
> +.Bl -tag -width "/etc/examples/bgpd.conf" -compact
>  .It Pa /etc/bgpd.conf
>  .Xr bgpd 8
>  configuration file
> +.It Pa /etc/examples/bgpd.conf
> +example file, do not edit
>  .El
>  .Sh SEE ALSO
>  .Xr strftime 3 ,
> 

Reply via email to