summaryrefslogtreecommitdiff
path: root/sysutils/etcupdate/files/etcupdate.8
blob: 454ee319d7574bdc98e8406869a26890e03c57fe (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
.\"	$NetBSD: etcupdate.8,v 1.2 2001/11/20 17:29:54 wiz Exp $
.\"
.\" Copyright (c) 2001 The NetBSD Foundation, Inc.
.\" All rights reserved.
.\"
.\" This code is derived from software contributed to The NetBSD Foundation
.\" by Martti Kuparinen.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"        This product includes software developed by the NetBSD
.\"        Foundation, Inc. and its contributors.
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
.\"    contributors may be used to endorse or promote products derived
.\"    from this software without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.Dd November 14, 2001
.Dt ETCUPDATE 8
.Os
.Sh NAME
.Nm etcupdate
.Nd update the configuration files in
.Pa /etc
.Sh SYNOPSIS
.Nm
.Op Fl h
.Op Fl p Ar pager
.Op Fl s Ar srcdir
.Op Fl t Ar temproot
.Op Fl v
.Op Fl w Ar width
.Sh DESCRIPTION
.Nm
is a tool to update the configuration files in
.Pa /etc
without the need of manually checking and modifying every file.
The user should run this script after performing an operating system
update (i.e. after running
.Pa make build
in
.Pa /usr/src )
to use the latest configuration files during reboot.
.Pp
.Nm
will first create a copy of the new configuration files and compare these
against the installed files.  The user is given the option of installing,
merging or deleting each modified or missing file.
.Pp
.Nm
also notes if the user installs certain special files and performs
corresponding tasks like remaking the device nodes or rebuilding a database
from the
.Pa /etc/mail/aliases
file.
.Sh ENVIRONMENT
.Bl -tag -width TEMPROOT
.It Ev TEMPROOT
The temporary files created from
.Pa /usr/src/etc
will be stored here.  These files will then be compared
against the currently installed files in the
.Pa /etc
directory.  By default this is
.Pa /tmp/temproot
but it can be changed either with the
.Fl t Ar temproot
argument or by defining the
.Ev TEMPROOT
variable.
.It Ev SRCDIR
The location of the
.Nx
sources files.  By default this is
.Pa /usr/src
but it can be changed either with the
.Fl s Ar srcdir
argument or by defining the
.Ev SRCDIR
variable.
.It Ev PAGER
The pager to use when displaying files.  By default this is
.Pa /usr/bin/more
but it can be changed either with the
.Fl p Ar pager
argument or by defining the
.Ev PAGER
variable.
.It Ev WIDTH
The screen width used during interactive merge. By default this is
80 but it can be changed either with the
.Fl w Ar width
argument or by defining the
.Ev WIDTH
variable.
This is useful for
.Xr xterm 1
users with wider shell windows.
.El
.Sh FILES
The environment variables can also be defined in the following configuration
files.  The user's personal configuration file settings override the global
settings.
.Bl -tag -offset indent
.It Pa /etc/etcupdate.conf
.It Pa ~/.etcupdaterc
.El
.Sh EXAMPLES
You have just upgraded your
.Nx
host from 1.5.2 to 1.5.3 and now it's time
to update the configuration files as well. This can be done with the
following command:
.Dl etcupdate
.Pp
To get a better idea what's going on, use the
.Fl v
flag:
.Dl etcupdate -v
.Pp
The default location of the source files is
.Pa /usr/src
but this may be overridden with the
.Fl s Ar srcdir
command line argument:
.Dl etcupdate -s /some/where/src
.Sh AUTHORS
The
script was written by Martti Kuparinen <martti@netbsd.org> and
improved by several other
.Nx
users.
.Pp
The idea for this script (including code fragments, variable names etc.)
came from the
.Fx
mergemaster (by Douglas Barton).  Unlike the
.Fx
mergemaster, this does not use CVS version tags to compare if
the files need to be updated. Files are compared with
.Xr cmp 1
as this is more reliable and the only way if the version numbers are the
same even though the files are different.