1 .\" Copyright (c) 2011-2014 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 Oo + Oc Ns = 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
62 For querying, return success if all requested variables are set
64 otherwise return error status.
65 For assignments, return success if no changes are required, otherwise failure.
68 prints a message stating whether variables are set and/or changes are required.
70 Print a description of the given variable.
72 Show default value(s) only (this is the same as setting RC_CONFS to NULL or
73 passing `-f' with a NULL file-argument).
75 Print query results as
78 .Pq for example, Ql var=value .
85 Operate on the specified file(s) instead of the files obtained by reading the
90 This option can be specified multiple times for additional files.
94 file each directive is in.
96 Print a short usage message to stderr and exit.
98 Print a full usage statement to stderr and exit.
100 Ignore unknown variables.
107 .Pq overrides So Fl R Ar dir Sc ; requires Xr jexec 8 .
109 Show only variable values, not their names.
111 Show only variable names, not their values.
114 Disable verbose and hide certain errors.
116 Operate within the root directory
122 Print the pathname of the specific
124 file where the directive was found.
126 Print version information to stdout and exit.
128 Remove variable(s) from specified file(s).
131 This utility has a similar syntax to
133 It shares the `-e' and `-n' options
135 and also has the same
137 syntax for making queries/assignments.
139 .Pq unlike Xr sysctl 8 ,
141 is supported for appending values.
145 serves to query/modify MIBs in the entrant kernel,
147 instead works on values in the system
151 The list of system configuration files is configured in the file
152 .Ql /etc/defaults/rc.conf
155 which by-default contains a space-separated list of pathnames.
157 systems, this defaults to the value "/etc/rc.conf /etc/rc.conf.local".
159 pathname is sourced in-order upon startup.
160 It is in the same fashion that
162 sources the configuration files before returning the value of the given
165 When supplied a variable name,
167 will return the value of the variable.
168 If the variable does not appear in any
171 an error is printed and error status is returned.
173 When changing values of a given variable, it does not matter if the variable
174 appears in any of the
177 If the variable does not appear in any of the files, it is appended to
178 the end of the first pathname in the
183 will replace only the last-occurrence in the last-file found to contain the
185 This gets the value to take effect next boot without heavily
186 modifying these integral files (yet taking care not to allow the file to
189 be called repeatedly).
191 The following environment variables are referenced by
193 .Bl -tag -width ".Ev RC_DEFAULTS"
197 .Pq even if set to NULL .
200 .Ql /etc/defaults/rc.conf
204 The following standard commands are required by
223 .Bl -tag -width ".Pa /etc/defaults/rc.conf" -compact
224 .It Pa /etc/defaults/rc.conf
226 .It Pa /etc/rc.conf.local
229 Below are some simple examples of how
231 can be used to query certain values from the
233 collection of system configuration files:
237 .Dl returns the value of $sshd_enable, usually YES or NO .
241 .Dl returns IP address of default router Pq if configured .
243 Working on other files, such as
247 -f /etc/crontab MAILTO
248 .Dl returns the value of the MAILTO setting Pq if configured .
250 Appending to existing values:
253 \&cloned_interfaces+=" gif0"
254 .Dl appends Qo \ gif0 Qc to $cloned_interfaces .
256 In addition to the above syntax,
260 PARAMETER expansion for changing the way values are reported, shown below:
264 .Dl returns $hostname up to (but not including) first `.' .
267 \&'network_interfaces%%[$IFS]*'
268 .Dl returns first word of $network_interfaces .
271 \&'ntpdate_flags##*[$IFS]'
272 .Dl returns last word of $ntpdate_flags (time server address) .
276 .Dl returns $usbd_flags or "default" if unset or NULL .
279 cloned_interfaces+"alternate"
280 .Dl returns "alternate" if $cloned_interfaces is set .
283 \&'#kern_securelevel'
284 .Dl returns length in characters of $kern_securelevel .
288 .Dl returns NULL and error status 2 if $hostname is unset Pq or if set, returns the value of $hostname with no error status .
292 .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 .
296 utility presently does not support the
298 collection of system configuration files
299 .Pq which requires a service name to be known during execution .
301 This will be corrected by a future enhancement.
312 utility first appeared in
315 .An Devin Teske Aq Mt dteske@FreeBSD.org
317 Brandon Gooch, Garrett Cooper, Julian Elischer, Pawel Jakub Dawidek,
318 Cyrille Lefevre, Ross West, Stefan Esser, Marco Steinbach, Jilles Tjoelker,
319 Allan Jude, and Lars Engels for suggestions, help, and testing.