1 .\" Copyright (c) 2011-2013 Devin Teske
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .Nd safely edit system rc files
37 .Op Fl j Ar jail | Fl R Ar dir
38 .Ar name Ns Op = Ns Ar value
43 .Op Fl j Ar jail | Fl R Ar dir
50 variables from the collection of system rc files and allows processes with
51 appropriate privilege to change values in a safe and effective manner.
53 The following options are available:
54 .Bl -tag -width indent+
56 Dump a list of all non-default configuration variables.
58 Dump a list of all configuration variables
61 Check if the value will change when assigning a new value.
64 prints a message stating whether a change would occur.
65 Exits with success if no change is necessary, else returns error status.
67 Print a description of the given variable.
69 Show default value(s) only (this is the same as setting RC_CONFS to NULL or
70 passing `-f' with a NULL file-argument).
72 Print query results as
75 .Pq for example, Ql var=value .
82 Operate on the specified file(s) instead of the files obtained by reading the
87 This option can be specified multiple times for additional files.
91 file each directive is in.
93 Print a short usage message to stderr and exit.
95 Print a full usage statement to stderr and exit.
97 Ignore unknown variables.
104 .Pq overrides So Fl R Ar dir Sc ; requires Xr jexec 8 .
106 Show only variable values, not their names.
108 Show only variable names, not their values.
111 Ignore previous occurrences of
115 Operate within the root directory
121 Print the pathname of the specific
123 file where the directive was found.
125 Print version information to stdout and exit.
127 Remove variable(s) from specified file(s).
130 This utility works similar to
132 It shares the `-e' and `-n' options
134 and also has the same
136 syntax for querying/setting configuration options.
140 serves to query/modify MIBs in the entrant kernel,
142 instead works on values in the system
146 The list of system configuration files is configured in the file
147 .Ql /etc/defaults/rc.conf
150 which by-default contains a space-separated list of pathnames.
152 systems, this defaults to the value "/etc/rc.conf /etc/rc.conf.local".
154 pathname is sourced in-order upon startup.
155 It is in the same fashion that
157 sources the configuration files before returning the value of the given
160 When supplied a variable name,
162 will return the value of the variable.
163 If the variable does not appear in any
166 an error is printed and error status is returned.
168 When changing values of a given variable, it does not matter if the variable
169 appears in any of the
172 If the variable does not appear in any of the files, it is appended to
173 the end of the first pathname in the
178 will replace only the last-occurrence in the last-file found to contain the
180 This gets the value to take effect next boot without heavily
181 modifying these integral files (yet taking care not to allow the file to
184 be called repeatedly).
186 The following environment variables are referenced by
188 .Bl -tag -width ".Ev RC_DEFAULTS"
192 .Pq even if set to NULL .
195 .Ql /etc/defaults/rc.conf
199 The following standard commands are required by
218 .Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact
219 .It Pa /etc/defaults/rc.conf
221 .It Pa /etc/rc.conf.local
224 Below are some simple examples of how
226 can be used to query certain values from the
228 collection of system configuration files:
232 .Dl returns the value of $sshd_enable, usually YES or NO .
236 .Dl returns IP address of default router Pq if configured .
238 Working on other files, such as
242 -f /etc/crontab MAILTO
243 .Dl returns the value of the MAILTO setting Pq if configured .
245 In addition to the above syntax,
249 PARAMETER expansion for changing the way values are reported, shown below:
253 .Dl returns $hostname up to (but not including) first `.' .
256 \&'network_interfaces%%[$IFS]*'
257 .Dl returns first word of $network_interfaces .
260 \&'ntpdate_flags##*[$IFS]'
261 .Dl returns last word of $ntpdate_flags (time server address) .
265 .Dl returns $usbd_flags or "default" if unset or NULL .
268 cloned_interfaces+"alternate"
269 .Dl returns "alternate" if $cloned_interfaces is set .
272 \&'#kern_securelevel'
273 .Dl returns length in characters of $kern_securelevel .
277 .Dl returns NULL and error status 2 if $hostname is unset Pq or if set, returns the value of $hostname with no error status .
281 .Dl returns NULL and error status 2 if $hostname is unset or NULL Pq or if set and non-NULL, returns value without error status .
285 utility presently does not support the
287 collection of system configuration files
288 .Pq which requires a service name to be known during execution .
290 This will be corrected by a future enhancement.
301 utility first appeared in
304 .An Devin Teske Aq Mt dteske@FreeBSD.org
306 Brandon Gooch, Garrett Cooper, Julian Elischer, Pawel Jakub Dawidek,
307 Cyrille Lefevre, Ross West, Stefan Esser, Marco Steinbach, and Jilles Tjoelker
308 for suggestions and help.