[Midnightbsd-cvs] src [10809] trunk/usr.sbin/etcupdate/etcupdate.8: update man page

[laffer1 at midnightbsd.org]

Revision: 10809
          http://svnweb.midnightbsd.org/src/?rev=10809
Author:   laffer1
Date:     2018-06-10 14:06:11 -0400 (Sun, 10 Jun 2018)
Log Message:
-----------
update man page

Modified Paths:
--------------
    trunk/usr.sbin/etcupdate/etcupdate.8

Modified: trunk/usr.sbin/etcupdate/etcupdate.8
===================================================================
--- trunk/usr.sbin/etcupdate/etcupdate.8	2018-06-10 18:05:58 UTC (rev 10808)
+++ trunk/usr.sbin/etcupdate/etcupdate.8	2018-06-10 18:06:11 UTC (rev 10809)
@@ -1,4 +1,5 @@
-.\" Copyright (c) 2010-2013 Advanced Computing Technologies LLC
+.\" $MidnightBSD$
+.\" Copyright (c) 2010-2013 Hudson River Trading LLC
 .\" Written by: John H. Baldwin <jhb at FreeBSD.org>
 .\" All rights reserved.
 .\"
@@ -23,10 +24,9 @@
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.\" $FreeBSD: stable/9/usr.sbin/etcupdate/etcupdate.8 260650 2014-01-14 21:20:51Z jhb $
-.\" $MidnightBSD$
+.\" $FreeBSD: stable/10/usr.sbin/etcupdate/etcupdate.8 288505 2015-10-02 16:21:14Z bdrewery $
 .\"
-.Dd December 9, 2013
+.Dd September 29, 2015
 .Dt ETCUPDATE 8
 .Os
 .Sh NAME
@@ -234,6 +234,16 @@
 is invoked if
 .Pa /etc/mail/aliases
 is changed,
+.Xr services_mkdb 8
+is invoked if
+.Pa /etc/services
+is changed,
+.Xr tzsetup 8
+is invoked if
+.Pa /etc/localtime
+is changed and if
+.Fa /var/db/zoneinfo
+exists,
 and
 .Pa /etc/rc.d/motd
 is invoked if
@@ -609,12 +619,11 @@
 .Sh EXIT STATUS
 .Ex -std
 .Sh EXAMPLES
-If the source tree matches the currently installed world,
-then the following can be used to bootstrap
-.Nm
-so that it can be used for future upgrades:
+To compare the files in
+.Pa /etc
+with the stock versions:
 .Pp
-.Dl "etcupdate extract"
+.Dl "etcupdate diff"
 .Pp
 To merge changes after an upgrade via the buildworld and installworld process:
 .Pp
@@ -623,6 +632,59 @@
 To resolve any conflicts generated during a merge:
 .Pp
 .Dl "etcupdate resolve"
+.Ss Bootstrapping
+The
+.Nm
+utility may need to be bootstrapped before it can be used.
+The
+.Cm diff
+command will fail with an error about a missing reference tree if
+bootstrapping is needed.
+.Pp
+Bootstrapping
+.Nm
+requires a source tree that matches the currently installed world.
+The easiest way to ensure this is to bootstrap
+.Nm
+before updating the source tree to start the next world upgrade cycle.
+First,
+generate a reference tree:
+.Pp
+.Dl "etcupdate extract"
+.Pp
+Second,
+use the
+.Cm diff
+command to compare the reference tree to your current files in
+.Pa /etc .
+Undesired differences should be removed using an editor,
+.Xr patch 1 ,
+or by copying files from the reference tree
+.Po
+located at
+.Pa /var/db/etcupdate/current
+by default
+.Pc
+.
+.Pp
+If the tree at
+.Pa /usr/src
+is already newer than the currently installed world,
+a new tree matching the currently installed world can be checked out to
+a temporary location.
+The reference tree for
+.Nm
+can then be generated via:
+.Pp
+.Dl "etcupdate extract -s /path/to/tree"
+.Pp
+The
+.Cm diff
+command can be used as above to remove undesired differences.
+Afterwards,
+the changes in the tree at
+.Pa /usr/src
+can be merged via a regular merge.
 .Sh DIAGNOSTICS
 The following warning messages may be generated during a merge.
 Note that several of these warnings cover obscure cases that should occur
@@ -792,7 +854,9 @@
 .Xr make 1 ,
 .Xr newaliases 1 ,
 .Xr sh 1 ,
-.Xr pwd_mkdb 8
+.Xr pwd_mkdb 8 ,
+.Xr services_mkdb 8 ,
+.Xr tzsetup 8
 .Sh HISTORY
 The
 .Nm